diff --git a/README.md b/README.md index f2836913..5578d601 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,10 @@ DefaultEcs is an [Entity Component System](https://en.wikipedia.org/wiki/Entity_ - [SequentialSystem](#Overview_System_SequentialSystem) - [AEntitySystem](#Overview_System_AEntitySystem) - [AComponentSystem](#Overview_System_AComponentSystem) - - [SystemRunner](#Overview_System_SystemRunner) + - [Threading](#Overview_Threading) + - [IParallelRunnable](#Overview_Threading_IParallelRunnable) + - [IParallelRunner](#Overview_Threading_IParallelRunner) + - [DefaultParallelRunner](#Overview_Threading_DefaultParallelRunner) - [Command](#Overview_Command) - [Message](#Overview_Message) - [Serialization](#Overview_Serialization) @@ -171,16 +174,16 @@ To perform operation, systems should get EntitySet from the World instance. Enti EntitySet are created from EntitySetBuilder and it is possible to apply rules for required components or excluded components ```csharp // this set when enumerated will give all the entities with an Example component -EntitySet set = world.GetEntities().With().Build(); +EntitySet set = world.GetEntities().With().AsSet(); // this set when enumerated will give all the entities without an Example component -EntitySet set = world.GetEntities().Without().Build(); +EntitySet set = world.GetEntities().Without().AsSet(); // this set when enumerated will give all the entities with both an Example and an int component -EntitySet set = world.GetEntities().With().With().Build(); +EntitySet set = world.GetEntities().With().With().AsSet(); // this set when enumerated will give all the entities with either an Example or an int component -EntitySet set = world.GetEntities().WithEither().Build(); +EntitySet set = world.GetEntities().WithEither().Or().AsSet(); // this gives all the component of type Example currently used in the world Span components = world.GetAllComponents(); @@ -256,7 +259,7 @@ This is a base class to create system to update a given EntitySet. ```csharp public sealed class VelocitySystem : AEntitySystem { - public VelocitySystem(World world, SystemRunner runner) + public VelocitySystem(World world, IParallelRunner runner) : base(world.GetEntities().With().With().Build(), runner) { } @@ -280,7 +283,7 @@ It is also possible to declare the needed component by using the WithAttribute a [With(typeof(Position)] public sealed class VelocitySystem : AEntitySystem { - public VelocitySystem(World world, SystemRunner runner) + public VelocitySystem(World world, IParallelRunner runner) : base(world, runner) { } @@ -331,18 +334,17 @@ public class DrawSystem : AComponentSystem } ``` - -### SystemRunner -While not directly a system, an instance of this class can be given to base constructor of AEntitySystem and AComponentSystem to provide multithreading processing of system. + +## Threading +Some systems are compatible with multithreading execution: ParallelSystem, AEntitySystem and AComponentSystem. This is done by passing a IParallelRunner to their respective constructor. ```csharp -SystemRunner runner = new SystemRunner(Environment.ProcessorCount); +IParallelRunner runner = new DefaultSystemRunner(Environment.ProcessorCount); ISystem system = new VelocitySystem(world, runner); // this will process the update on Environment.ProcessorCount threads system.Update(elaspedTime); ``` - It is safe to run a system with multithreading when: * for an AEntitySystem * each entity can be safely updated separately with no dependency to an other entity @@ -350,6 +352,55 @@ It is safe to run a system with multithreading when: * for an AComponentSystem * each component can be safely updated separately with no dependency to an other component + +### IParallelRunnable +This interface allow the creation of custom parallelisable process by an IParallelRunner. +```csharp +IParallelRunner runner = new DefaultSystemRunner(Environment.ProcessorCount); + +public class CustomRunnable : IParallelRunnable +{ + public void Run(int index, int maxIndex) + { + // a runnable is separated in maxIndex part to run in parallel, index gives you the part running + } +} + +runner.Run(new CustomRunnable()); +``` + + +### IParallelRunner +This interface allow the creation of custom parallel execution. +```csharp +IParallelRunner runner = new DefaultSystemRunner(Environment.ProcessorCount); + +public class TaskRunner : IParallelRunner +{ + int DegreeOfParallelism { get; } + + public void Run(IParallelRunnable runnable) Enumerable.Range(0, DegreeOfParallelism).AsParallel().ForAll(i => runnable.Run(i, DegreeOfParallelism)); +} +``` + + +### DefaultParallelRunner +This is the default implementation of IParallelRunner. it uses exclusive Task to run an IParallelRunnable and only return when the full runnable has been processed. When `index == maxIndex` this is the calling thread. +It is safe to reuse the same DefaultParallelRunner in multiple system but it should not be used in parallel itself. +```csharp +IParallelRunner runner = new DefaultSystemRunner(Environment.ProcessorCount); + +// wrong +ISystem system = new ParallelSystem(runner, + new ParallelSystem1(runner), + new ParallelSystem2(runner)); + +// ok +ISystem system = new SequentialSystem( + new ParallelSystem1(runner), + new ParallelSystem2(runner)); +``` + ## Command Since it is not possible to make structural modification on an Entity in a multithreading context, the EntityCommandRecorder type is provided to adress this short-coming. diff --git a/documentation/RELEASENOTE.md b/documentation/RELEASENOTE.md index 12822f73..008ef39d 100644 --- a/documentation/RELEASENOTE.md +++ b/documentation/RELEASENOTE.md @@ -1,3 +1,22 @@ +## DefaultEcs 0.13.0 +breaking change: +removed SystemRunner type, use DefaultEcs.Threading.DefaultParallelRunner instead +removed ASystem type +refactored EntitySetBuilder to a more fluent syntax, Build changed to AsSet, *Either<T1, T2>() replaced by *Either<T1>().Or<T2>() + +added World.GetDisabledEntities method to create EntitySet for disabled entities +added DisabledAttribute to auto construct EntitySet of disabled entities for AEntitySystem +added EntitySet.Contains method to check for an Entity inclusion +added IParallelRunner to allow custom implementation to process AEntitySystem, AComponentSystem and ParallelSystem in parallel +added Entity.World property + +fixed EntityCommandRecorder SetSameAs and Dispose command +fixed size of commands in EntityCommandRecorder +fixed size of Entity +fixed WithoutEitherAttribute filter generation + +[nuget package](https://www.nuget.org/packages/DefaultEcs/0.13.0) + ## DefaultEcs 0.12.1 fixed serialization of struct as an object fixed serialization of Type diff --git a/documentation/api/DefaultEcs-Entity-World.md b/documentation/api/DefaultEcs-Entity-World.md new file mode 100644 index 00000000..bd886646 --- /dev/null +++ b/documentation/api/DefaultEcs-Entity-World.md @@ -0,0 +1,9 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') +## Entity.World Property +Gets the [World](./DefaultEcs-World.md 'DefaultEcs.World') instance from which current [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') originate. +```C# +public DefaultEcs.World World { get; } +``` +#### Returns +[World](./DefaultEcs-World.md 'DefaultEcs.World') diff --git a/documentation/api/DefaultEcs-Entity.md b/documentation/api/DefaultEcs-Entity.md index 26c721ee..6ceb8a74 100644 --- a/documentation/api/DefaultEcs-Entity.md +++ b/documentation/api/DefaultEcs-Entity.md @@ -11,6 +11,7 @@ IEquatable Implements [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable 'System.IDisposable'), [System.IEquatable<](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1')[Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity')[>](https://docs.microsoft.com/en-us/dotnet/api/System.IEquatable-1 'System.IEquatable`1') ### Properties - [IsAlive](./DefaultEcs-Entity-IsAlive.md 'DefaultEcs.Entity.IsAlive') +- [World](./DefaultEcs-Entity-World.md 'DefaultEcs.Entity.World') ### Methods - [CopyTo(DefaultEcs.World)](./DefaultEcs-Entity-CopyTo(DefaultEcs-World).md 'DefaultEcs.Entity.CopyTo(DefaultEcs.World)') - [Disable()](./DefaultEcs-Entity-Disable().md 'DefaultEcs.Entity.Disable()') diff --git a/documentation/api/DefaultEcs-EntitySet-Contains(DefaultEcs-Entity).md b/documentation/api/DefaultEcs-EntitySet-Contains(DefaultEcs-Entity).md new file mode 100644 index 00000000..eff580ae --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySet-Contains(DefaultEcs-Entity).md @@ -0,0 +1,15 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet') +## EntitySet.Contains(DefaultEcs.Entity) Method +Determines whether an [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') is in the [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet'). +```C# +public bool Contains(in DefaultEcs.Entity entity); +``` +#### Parameters + +`entity` [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') +The [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') to locate in the [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet'). + +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') +true if [entity](#DefaultEcs-EntitySet-Contains(DefaultEcs-Entity)-entity 'DefaultEcs.EntitySet.Contains(DefaultEcs.Entity).entity') is found in the [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet'); otherwise, false. diff --git a/documentation/api/DefaultEcs-EntitySet.md b/documentation/api/DefaultEcs-EntitySet.md index fa3b186e..30298ce6 100644 --- a/documentation/api/DefaultEcs-EntitySet.md +++ b/documentation/api/DefaultEcs-EntitySet.md @@ -13,6 +13,7 @@ Implements [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/Syst - [Count](./DefaultEcs-EntitySet-Count.md 'DefaultEcs.EntitySet.Count') ### Methods - [Complete()](./DefaultEcs-EntitySet-Complete().md 'DefaultEcs.EntitySet.Complete()') +- [Contains(DefaultEcs.Entity)](./DefaultEcs-EntitySet-Contains(DefaultEcs-Entity).md 'DefaultEcs.EntitySet.Contains(DefaultEcs.Entity)') - [Dispose()](./DefaultEcs-EntitySet-Dispose().md 'DefaultEcs.EntitySet.Dispose()') - [GetEntities()](./DefaultEcs-EntitySet-GetEntities().md 'DefaultEcs.EntitySet.GetEntities()') ### Events diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-Build().md b/documentation/api/DefaultEcs-EntitySetBuilder-AsSet().md similarity index 85% rename from documentation/api/DefaultEcs-EntitySetBuilder-Build().md rename to documentation/api/DefaultEcs-EntitySetBuilder-AsSet().md index bd85af31..6faed098 100644 --- a/documentation/api/DefaultEcs-EntitySetBuilder-Build().md +++ b/documentation/api/DefaultEcs-EntitySetBuilder-AsSet().md @@ -1,9 +1,9 @@ #### [DefaultEcs](./index.md 'index') ### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -## EntitySetBuilder.Build() Method +## EntitySetBuilder.AsSet() Method Returns an [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet') with the specified rules. ```C# -public DefaultEcs.EntitySet Build(); +public DefaultEcs.EntitySet AsSet(); ``` #### Returns [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet') diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-AsSet().md b/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-AsSet().md new file mode 100644 index 00000000..442685c2 --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-AsSet().md @@ -0,0 +1,10 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder').[EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') +## EitherBuilder.AsSet() Method +Returns an [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet') with the specified rules. +```C# +public DefaultEcs.EntitySet AsSet(); +``` +#### Returns +[EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet') +The [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-Or-T-().md b/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-Or-T-().md new file mode 100644 index 00000000..6fc30210 --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-Or-T-().md @@ -0,0 +1,15 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder').[EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') +## EitherBuilder.Or<T>() Method +Add the type [T](#DefaultEcs-EntitySetBuilder-EitherBuilder-Or-T-()-T 'DefaultEcs.EntitySetBuilder.EitherBuilder.Or<T>().T') to current either group. +```C# +public DefaultEcs.EntitySetBuilder.EitherBuilder Or(); +``` +#### Type parameters + +`T` +The type of component to add to the either group. + +#### Returns +[EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') +The current [EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-WhenAdded-T-().md b/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-WhenAdded-T-().md new file mode 100644 index 00000000..11d68cee --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-WhenAdded-T-().md @@ -0,0 +1,15 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder').[EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') +## EitherBuilder.WhenAdded<T>() Method +Makes a rule to observe [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when a component of type [T](#DefaultEcs-EntitySetBuilder-EitherBuilder-WhenAdded-T-()-T 'DefaultEcs.EntitySetBuilder.EitherBuilder.WhenAdded<T>().T') is added. +```C# +public DefaultEcs.EntitySetBuilder WhenAdded(); +``` +#### Type parameters + +`T` +The type of component. + +#### Returns +[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-WhenAddedEither-T-().md b/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-WhenAddedEither-T-().md new file mode 100644 index 00000000..e752ec59 --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-WhenAddedEither-T-().md @@ -0,0 +1,15 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder').[EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') +## EitherBuilder.WhenAddedEither<T>() Method +Makes a rule to observe [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when one component of the either group is added. +```C# +public DefaultEcs.EntitySetBuilder.EitherBuilder WhenAddedEither(); +``` +#### Type parameters + +`T` +The type of component to add to the either group. + +#### Returns +[EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') +A [EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') to create a either group. diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-WhenChanged-T-().md b/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-WhenChanged-T-().md new file mode 100644 index 00000000..976cf8a8 --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-WhenChanged-T-().md @@ -0,0 +1,15 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder').[EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') +## EitherBuilder.WhenChanged<T>() Method +Makes a rule to observe [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when a component of type [T](#DefaultEcs-EntitySetBuilder-EitherBuilder-WhenChanged-T-()-T 'DefaultEcs.EntitySetBuilder.EitherBuilder.WhenChanged<T>().T') is changed. +```C# +public DefaultEcs.EntitySetBuilder WhenChanged(); +``` +#### Type parameters + +`T` +The type of component. + +#### Returns +[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-WhenChangedEither-T-().md b/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-WhenChangedEither-T-().md new file mode 100644 index 00000000..97b907df --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-WhenChangedEither-T-().md @@ -0,0 +1,15 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder').[EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') +## EitherBuilder.WhenChangedEither<T>() Method +Makes a rule to observe [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when one component of the either group is changed. +```C# +public DefaultEcs.EntitySetBuilder.EitherBuilder WhenChangedEither(); +``` +#### Type parameters + +`T` +The type of component to add to the either group. + +#### Returns +[EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') +A [EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') to create a either group. diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-WhenRemoved-T-().md b/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-WhenRemoved-T-().md new file mode 100644 index 00000000..cd616b76 --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-WhenRemoved-T-().md @@ -0,0 +1,15 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder').[EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') +## EitherBuilder.WhenRemoved<T>() Method +Makes a rule to observe [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when a component of type [T](#DefaultEcs-EntitySetBuilder-EitherBuilder-WhenRemoved-T-()-T 'DefaultEcs.EntitySetBuilder.EitherBuilder.WhenRemoved<T>().T') is removed. +```C# +public DefaultEcs.EntitySetBuilder WhenRemoved(); +``` +#### Type parameters + +`T` +The type of component. + +#### Returns +[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-WhenRemovedEither-T-().md b/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-WhenRemovedEither-T-().md new file mode 100644 index 00000000..2295a460 --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-WhenRemovedEither-T-().md @@ -0,0 +1,15 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder').[EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') +## EitherBuilder.WhenRemovedEither<T>() Method +Makes a rule to observe [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when one component of the either group is removed. +```C# +public DefaultEcs.EntitySetBuilder.EitherBuilder WhenRemovedEither(); +``` +#### Type parameters + +`T` +The type of component to add to the either group. + +#### Returns +[EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') +A [EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') to create a either group. diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-With-T-().md b/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-With-T-().md new file mode 100644 index 00000000..2465b9d0 --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-With-T-().md @@ -0,0 +1,15 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder').[EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') +## EitherBuilder.With<T>() Method +Makes a rule to observe [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') with a component of type [T](#DefaultEcs-EntitySetBuilder-EitherBuilder-With-T-()-T 'DefaultEcs.EntitySetBuilder.EitherBuilder.With<T>().T'). +```C# +public DefaultEcs.EntitySetBuilder With(); +``` +#### Type parameters + +`T` +The type of component. + +#### Returns +[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-WithEither-T-().md b/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-WithEither-T-().md new file mode 100644 index 00000000..13533970 --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-WithEither-T-().md @@ -0,0 +1,15 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder').[EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') +## EitherBuilder.WithEither<T>() Method +Makes a rule to obsverve [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') with at least one component of the either group. +```C# +public DefaultEcs.EntitySetBuilder.EitherBuilder WithEither(); +``` +#### Type parameters + +`T` +The type of component to add to the either group. + +#### Returns +[EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') +A [EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') to create a either group. diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-Without-T-().md b/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-Without-T-().md new file mode 100644 index 00000000..6ead1117 --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-Without-T-().md @@ -0,0 +1,15 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder').[EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') +## EitherBuilder.Without<T>() Method +Makes a rule to ignore [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') with a component of type [T](#DefaultEcs-EntitySetBuilder-EitherBuilder-Without-T-()-T 'DefaultEcs.EntitySetBuilder.EitherBuilder.Without<T>().T'). +```C# +public DefaultEcs.EntitySetBuilder Without(); +``` +#### Type parameters + +`T` +The type of component. + +#### Returns +[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-WithoutEither-T-().md b/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-WithoutEither-T-().md new file mode 100644 index 00000000..0d727f32 --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder-WithoutEither-T-().md @@ -0,0 +1,15 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder').[EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') +## EitherBuilder.WithoutEither<T>() Method +Makes a rule to obsverve [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') without at least one component of the either group. +```C# +public DefaultEcs.EntitySetBuilder.EitherBuilder WithoutEither(); +``` +#### Type parameters + +`T` +The type of component to add to the either group. + +#### Returns +[EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') +A [EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') to create a either group. diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder.md b/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder.md new file mode 100644 index 00000000..4647c171 --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilder-EitherBuilder.md @@ -0,0 +1,21 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +## EitherBuilder Class +Represents an helper object to create an either group for the construction of an [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet') containing a specific subset of [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity'). +```C# +public sealed class EntitySetBuilder.EitherBuilder +``` +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') > [EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') +### Methods +- [AsSet()](./DefaultEcs-EntitySetBuilder-EitherBuilder-AsSet().md 'DefaultEcs.EntitySetBuilder.EitherBuilder.AsSet()') +- [Or<T>()](./DefaultEcs-EntitySetBuilder-EitherBuilder-Or-T-().md 'DefaultEcs.EntitySetBuilder.EitherBuilder.Or<T>()') +- [WhenAdded<T>()](./DefaultEcs-EntitySetBuilder-EitherBuilder-WhenAdded-T-().md 'DefaultEcs.EntitySetBuilder.EitherBuilder.WhenAdded<T>()') +- [WhenAddedEither<T>()](./DefaultEcs-EntitySetBuilder-EitherBuilder-WhenAddedEither-T-().md 'DefaultEcs.EntitySetBuilder.EitherBuilder.WhenAddedEither<T>()') +- [WhenChanged<T>()](./DefaultEcs-EntitySetBuilder-EitherBuilder-WhenChanged-T-().md 'DefaultEcs.EntitySetBuilder.EitherBuilder.WhenChanged<T>()') +- [WhenChangedEither<T>()](./DefaultEcs-EntitySetBuilder-EitherBuilder-WhenChangedEither-T-().md 'DefaultEcs.EntitySetBuilder.EitherBuilder.WhenChangedEither<T>()') +- [WhenRemoved<T>()](./DefaultEcs-EntitySetBuilder-EitherBuilder-WhenRemoved-T-().md 'DefaultEcs.EntitySetBuilder.EitherBuilder.WhenRemoved<T>()') +- [WhenRemovedEither<T>()](./DefaultEcs-EntitySetBuilder-EitherBuilder-WhenRemovedEither-T-().md 'DefaultEcs.EntitySetBuilder.EitherBuilder.WhenRemovedEither<T>()') +- [With<T>()](./DefaultEcs-EntitySetBuilder-EitherBuilder-With-T-().md 'DefaultEcs.EntitySetBuilder.EitherBuilder.With<T>()') +- [WithEither<T>()](./DefaultEcs-EntitySetBuilder-EitherBuilder-WithEither-T-().md 'DefaultEcs.EntitySetBuilder.EitherBuilder.WithEither<T>()') +- [Without<T>()](./DefaultEcs-EntitySetBuilder-EitherBuilder-Without-T-().md 'DefaultEcs.EntitySetBuilder.EitherBuilder.Without<T>()') +- [WithoutEither<T>()](./DefaultEcs-EntitySetBuilder-EitherBuilder-WithoutEither-T-().md 'DefaultEcs.EntitySetBuilder.EitherBuilder.WithoutEither<T>()') diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-WhenAdded(System-Type--).md b/documentation/api/DefaultEcs-EntitySetBuilder-WhenAdded(System-Type--).md deleted file mode 100644 index 6e18062c..00000000 --- a/documentation/api/DefaultEcs-EntitySetBuilder-WhenAdded(System-Type--).md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -## EntitySetBuilder.WhenAdded(System.Type[]) Method -Makes a rule to obsverve [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when all component of the given types are added. -```C# -public DefaultEcs.EntitySetBuilder WhenAdded(params System.Type[] componentTypes); -``` -#### Parameters - -`componentTypes` [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') -The types of component. - -#### Returns -[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-WhenAddedEither(System-Type--).md b/documentation/api/DefaultEcs-EntitySetBuilder-WhenAddedEither(System-Type--).md deleted file mode 100644 index 87cc1d2c..00000000 --- a/documentation/api/DefaultEcs-EntitySetBuilder-WhenAddedEither(System-Type--).md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -## EntitySetBuilder.WhenAddedEither(System.Type[]) Method -Makes a rule to observe [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when one component of the given types is added. -```C# -public DefaultEcs.EntitySetBuilder WhenAddedEither(params System.Type[] componentTypes); -``` -#### Parameters - -`componentTypes` [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') -The types of component. - -#### Returns -[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-WhenAddedEither-T-().md b/documentation/api/DefaultEcs-EntitySetBuilder-WhenAddedEither-T-().md new file mode 100644 index 00000000..0768555b --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilder-WhenAddedEither-T-().md @@ -0,0 +1,15 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +## EntitySetBuilder.WhenAddedEither<T>() Method +Makes a rule to observe [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when one component of the either group is added. +```C# +public DefaultEcs.EntitySetBuilder.EitherBuilder WhenAddedEither(); +``` +#### Type parameters + +`T` +The type of component to add to the either group. + +#### Returns +[EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') +A [EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') to create a either group. diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-WhenChanged(System-Type--).md b/documentation/api/DefaultEcs-EntitySetBuilder-WhenChanged(System-Type--).md deleted file mode 100644 index fb86160a..00000000 --- a/documentation/api/DefaultEcs-EntitySetBuilder-WhenChanged(System-Type--).md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -## EntitySetBuilder.WhenChanged(System.Type[]) Method -Makes a rule to obsverve [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when all component of the given types are changed. -```C# -public DefaultEcs.EntitySetBuilder WhenChanged(params System.Type[] componentTypes); -``` -#### Parameters - -`componentTypes` [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') -The types of component. - -#### Returns -[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-WhenChangedEither(System-Type--).md b/documentation/api/DefaultEcs-EntitySetBuilder-WhenChangedEither(System-Type--).md deleted file mode 100644 index fd92429d..00000000 --- a/documentation/api/DefaultEcs-EntitySetBuilder-WhenChangedEither(System-Type--).md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -## EntitySetBuilder.WhenChangedEither(System.Type[]) Method -Makes a rule to observe [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when one component of the given types is changed. -```C# -public DefaultEcs.EntitySetBuilder WhenChangedEither(params System.Type[] componentTypes); -``` -#### Parameters - -`componentTypes` [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') -The types of component. - -#### Returns -[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-WhenChangedEither-T-().md b/documentation/api/DefaultEcs-EntitySetBuilder-WhenChangedEither-T-().md new file mode 100644 index 00000000..5cc0a707 --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilder-WhenChangedEither-T-().md @@ -0,0 +1,15 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +## EntitySetBuilder.WhenChangedEither<T>() Method +Makes a rule to observe [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when one component of the either group is changed. +```C# +public DefaultEcs.EntitySetBuilder.EitherBuilder WhenChangedEither(); +``` +#### Type parameters + +`T` +The type of component to add to the either group. + +#### Returns +[EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') +A [EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') to create a either group. diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-WhenRemoved(System-Type--).md b/documentation/api/DefaultEcs-EntitySetBuilder-WhenRemoved(System-Type--).md deleted file mode 100644 index 3fb7e6a5..00000000 --- a/documentation/api/DefaultEcs-EntitySetBuilder-WhenRemoved(System-Type--).md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -## EntitySetBuilder.WhenRemoved(System.Type[]) Method -Makes a rule to obsverve [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when all component of the given types are removed. -```C# -public DefaultEcs.EntitySetBuilder WhenRemoved(params System.Type[] componentTypes); -``` -#### Parameters - -`componentTypes` [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') -The types of component. - -#### Returns -[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-WhenRemovedEither(System-Type--).md b/documentation/api/DefaultEcs-EntitySetBuilder-WhenRemovedEither(System-Type--).md deleted file mode 100644 index c8066744..00000000 --- a/documentation/api/DefaultEcs-EntitySetBuilder-WhenRemovedEither(System-Type--).md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -## EntitySetBuilder.WhenRemovedEither(System.Type[]) Method -Makes a rule to observe [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when one component of the given types is removed. -```C# -public DefaultEcs.EntitySetBuilder WhenRemovedEither(params System.Type[] componentTypes); -``` -#### Parameters - -`componentTypes` [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') -The types of component. - -#### Returns -[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-WhenRemovedEither-T-().md b/documentation/api/DefaultEcs-EntitySetBuilder-WhenRemovedEither-T-().md new file mode 100644 index 00000000..d3bf6089 --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilder-WhenRemovedEither-T-().md @@ -0,0 +1,15 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +## EntitySetBuilder.WhenRemovedEither<T>() Method +Makes a rule to observe [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when one component of the either group is removed. +```C# +public DefaultEcs.EntitySetBuilder.EitherBuilder WhenRemovedEither(); +``` +#### Type parameters + +`T` +The type of component to add to the either group. + +#### Returns +[EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') +A [EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') to create a either group. diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-With(System-Type--).md b/documentation/api/DefaultEcs-EntitySetBuilder-With(System-Type--).md deleted file mode 100644 index 58bc3767..00000000 --- a/documentation/api/DefaultEcs-EntitySetBuilder-With(System-Type--).md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -## EntitySetBuilder.With(System.Type[]) Method -Makes a rule to obsverve [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') with all component of the given types. -```C# -public DefaultEcs.EntitySetBuilder With(params System.Type[] componentTypes); -``` -#### Parameters - -`componentTypes` [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') -The types of component. - -#### Returns -[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-WithEither(System-Type--).md b/documentation/api/DefaultEcs-EntitySetBuilder-WithEither(System-Type--).md deleted file mode 100644 index 1c2eaaf1..00000000 --- a/documentation/api/DefaultEcs-EntitySetBuilder-WithEither(System-Type--).md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -## EntitySetBuilder.WithEither(System.Type[]) Method -Makes a rule to obsverve [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') with at least one component of the given types. -```C# -public DefaultEcs.EntitySetBuilder WithEither(params System.Type[] componentTypes); -``` -#### Parameters - -`componentTypes` [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') -The types of component. - -#### Returns -[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-WithEither-T-().md b/documentation/api/DefaultEcs-EntitySetBuilder-WithEither-T-().md new file mode 100644 index 00000000..7b848b4d --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilder-WithEither-T-().md @@ -0,0 +1,15 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +## EntitySetBuilder.WithEither<T>() Method +Makes a rule to obsverve [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') with at least one component of the either group. +```C# +public DefaultEcs.EntitySetBuilder.EitherBuilder WithEither(); +``` +#### Type parameters + +`T` +The type of component to add to the either group. + +#### Returns +[EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') +A [EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') to create a either group. diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-Without(System-Type--).md b/documentation/api/DefaultEcs-EntitySetBuilder-Without(System-Type--).md deleted file mode 100644 index 53ce21fd..00000000 --- a/documentation/api/DefaultEcs-EntitySetBuilder-Without(System-Type--).md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -## EntitySetBuilder.Without(System.Type[]) Method -Makes a rule to ignore [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') with at least one component of the given types. -```C# -public DefaultEcs.EntitySetBuilder Without(params System.Type[] componentTypes); -``` -#### Parameters - -`componentTypes` [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') -The types of component. - -#### Returns -[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-WithoutEither(System-Type--).md b/documentation/api/DefaultEcs-EntitySetBuilder-WithoutEither(System-Type--).md deleted file mode 100644 index 2b4fa959..00000000 --- a/documentation/api/DefaultEcs-EntitySetBuilder-WithoutEither(System-Type--).md +++ /dev/null @@ -1,15 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -## EntitySetBuilder.WithoutEither(System.Type[]) Method -Makes a rule to obsverve [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') without at least one component of the given types. -```C# -public DefaultEcs.EntitySetBuilder WithoutEither(params System.Type[] componentTypes); -``` -#### Parameters - -`componentTypes` [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') -The types of component. - -#### Returns -[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-WithoutEither-T-().md b/documentation/api/DefaultEcs-EntitySetBuilder-WithoutEither-T-().md new file mode 100644 index 00000000..0977dca0 --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilder-WithoutEither-T-().md @@ -0,0 +1,15 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +## EntitySetBuilder.WithoutEither<T>() Method +Makes a rule to obsverve [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') without at least one component of the either group. +```C# +public DefaultEcs.EntitySetBuilder.EitherBuilder WithoutEither(); +``` +#### Type parameters + +`T` +The type of component to add to the either group. + +#### Returns +[EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') +A [EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') to create a either group. diff --git a/documentation/api/DefaultEcs-EntitySetBuilder.md b/documentation/api/DefaultEcs-EntitySetBuilder.md index be7c3e38..27b932d5 100644 --- a/documentation/api/DefaultEcs-EntitySetBuilder.md +++ b/documentation/api/DefaultEcs-EntitySetBuilder.md @@ -7,19 +7,26 @@ public sealed class EntitySetBuilder ``` Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') > [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') ### Methods -- [Build()](./DefaultEcs-EntitySetBuilder-Build().md 'DefaultEcs.EntitySetBuilder.Build()') -- [WhenAdded(System.Type[])](./DefaultEcs-EntitySetBuilder-WhenAdded(System-Type--).md 'DefaultEcs.EntitySetBuilder.WhenAdded(System.Type[])') +- [AsSet()](./DefaultEcs-EntitySetBuilder-AsSet().md 'DefaultEcs.EntitySetBuilder.AsSet()') - [WhenAdded<T>()](./DefaultEcs-EntitySetBuilder-WhenAdded-T-().md 'DefaultEcs.EntitySetBuilder.WhenAdded<T>()') -- [WhenAddedEither(System.Type[])](./DefaultEcs-EntitySetBuilder-WhenAddedEither(System-Type--).md 'DefaultEcs.EntitySetBuilder.WhenAddedEither(System.Type[])') -- [WhenChanged(System.Type[])](./DefaultEcs-EntitySetBuilder-WhenChanged(System-Type--).md 'DefaultEcs.EntitySetBuilder.WhenChanged(System.Type[])') +- [WhenAddedEither<T>()](./DefaultEcs-EntitySetBuilder-WhenAddedEither-T-().md 'DefaultEcs.EntitySetBuilder.WhenAddedEither<T>()') - [WhenChanged<T>()](./DefaultEcs-EntitySetBuilder-WhenChanged-T-().md 'DefaultEcs.EntitySetBuilder.WhenChanged<T>()') -- [WhenChangedEither(System.Type[])](./DefaultEcs-EntitySetBuilder-WhenChangedEither(System-Type--).md 'DefaultEcs.EntitySetBuilder.WhenChangedEither(System.Type[])') -- [WhenRemoved(System.Type[])](./DefaultEcs-EntitySetBuilder-WhenRemoved(System-Type--).md 'DefaultEcs.EntitySetBuilder.WhenRemoved(System.Type[])') +- [WhenChangedEither<T>()](./DefaultEcs-EntitySetBuilder-WhenChangedEither-T-().md 'DefaultEcs.EntitySetBuilder.WhenChangedEither<T>()') - [WhenRemoved<T>()](./DefaultEcs-EntitySetBuilder-WhenRemoved-T-().md 'DefaultEcs.EntitySetBuilder.WhenRemoved<T>()') -- [WhenRemovedEither(System.Type[])](./DefaultEcs-EntitySetBuilder-WhenRemovedEither(System-Type--).md 'DefaultEcs.EntitySetBuilder.WhenRemovedEither(System.Type[])') -- [With(System.Type[])](./DefaultEcs-EntitySetBuilder-With(System-Type--).md 'DefaultEcs.EntitySetBuilder.With(System.Type[])') +- [WhenRemovedEither<T>()](./DefaultEcs-EntitySetBuilder-WhenRemovedEither-T-().md 'DefaultEcs.EntitySetBuilder.WhenRemovedEither<T>()') - [With<T>()](./DefaultEcs-EntitySetBuilder-With-T-().md 'DefaultEcs.EntitySetBuilder.With<T>()') -- [WithEither(System.Type[])](./DefaultEcs-EntitySetBuilder-WithEither(System-Type--).md 'DefaultEcs.EntitySetBuilder.WithEither(System.Type[])') -- [Without(System.Type[])](./DefaultEcs-EntitySetBuilder-Without(System-Type--).md 'DefaultEcs.EntitySetBuilder.Without(System.Type[])') +- [WithEither<T>()](./DefaultEcs-EntitySetBuilder-WithEither-T-().md 'DefaultEcs.EntitySetBuilder.WithEither<T>()') - [Without<T>()](./DefaultEcs-EntitySetBuilder-Without-T-().md 'DefaultEcs.EntitySetBuilder.Without<T>()') -- [WithoutEither(System.Type[])](./DefaultEcs-EntitySetBuilder-WithoutEither(System-Type--).md 'DefaultEcs.EntitySetBuilder.WithoutEither(System.Type[])') +- [WithoutEither<T>()](./DefaultEcs-EntitySetBuilder-WithoutEither-T-().md 'DefaultEcs.EntitySetBuilder.WithoutEither<T>()') +- [AsSet()](./DefaultEcs-EntitySetBuilder-EitherBuilder-AsSet().md 'DefaultEcs.EntitySetBuilder.EitherBuilder.AsSet()') +- [Or<T>()](./DefaultEcs-EntitySetBuilder-EitherBuilder-Or-T-().md 'DefaultEcs.EntitySetBuilder.EitherBuilder.Or<T>()') +- [WhenAdded<T>()](./DefaultEcs-EntitySetBuilder-EitherBuilder-WhenAdded-T-().md 'DefaultEcs.EntitySetBuilder.EitherBuilder.WhenAdded<T>()') +- [WhenAddedEither<T>()](./DefaultEcs-EntitySetBuilder-EitherBuilder-WhenAddedEither-T-().md 'DefaultEcs.EntitySetBuilder.EitherBuilder.WhenAddedEither<T>()') +- [WhenChanged<T>()](./DefaultEcs-EntitySetBuilder-EitherBuilder-WhenChanged-T-().md 'DefaultEcs.EntitySetBuilder.EitherBuilder.WhenChanged<T>()') +- [WhenChangedEither<T>()](./DefaultEcs-EntitySetBuilder-EitherBuilder-WhenChangedEither-T-().md 'DefaultEcs.EntitySetBuilder.EitherBuilder.WhenChangedEither<T>()') +- [WhenRemoved<T>()](./DefaultEcs-EntitySetBuilder-EitherBuilder-WhenRemoved-T-().md 'DefaultEcs.EntitySetBuilder.EitherBuilder.WhenRemoved<T>()') +- [WhenRemovedEither<T>()](./DefaultEcs-EntitySetBuilder-EitherBuilder-WhenRemovedEither-T-().md 'DefaultEcs.EntitySetBuilder.EitherBuilder.WhenRemovedEither<T>()') +- [With<T>()](./DefaultEcs-EntitySetBuilder-EitherBuilder-With-T-().md 'DefaultEcs.EntitySetBuilder.EitherBuilder.With<T>()') +- [WithEither<T>()](./DefaultEcs-EntitySetBuilder-EitherBuilder-WithEither-T-().md 'DefaultEcs.EntitySetBuilder.EitherBuilder.WithEither<T>()') +- [Without<T>()](./DefaultEcs-EntitySetBuilder-EitherBuilder-Without-T-().md 'DefaultEcs.EntitySetBuilder.EitherBuilder.Without<T>()') +- [WithoutEither<T>()](./DefaultEcs-EntitySetBuilder-EitherBuilder-WithoutEither-T-().md 'DefaultEcs.EntitySetBuilder.EitherBuilder.WithoutEither<T>()') diff --git a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenAdded(DefaultEcs-EntitySetBuilder_System-Type--).md b/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenAdded(DefaultEcs-EntitySetBuilder_System-Type--).md new file mode 100644 index 00000000..91ac90d6 --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenAdded(DefaultEcs-EntitySetBuilder_System-Type--).md @@ -0,0 +1,19 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilderExtension](./DefaultEcs-EntitySetBuilderExtension.md 'DefaultEcs.EntitySetBuilderExtension') +## EntitySetBuilderExtension.WhenAdded(DefaultEcs.EntitySetBuilder, System.Type[]) Method +Makes a rule to obsverve [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when all component of the given types are added. +```C# +public static DefaultEcs.EntitySetBuilder WhenAdded(this DefaultEcs.EntitySetBuilder builder, params System.Type[] componentTypes); +``` +#### Parameters + +`builder` [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +The [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') on which to create the rule. + + +`componentTypes` [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') +The types of component. + +#### Returns +[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenAddedEither(DefaultEcs-EntitySetBuilder_System-Type--).md b/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenAddedEither(DefaultEcs-EntitySetBuilder_System-Type--).md new file mode 100644 index 00000000..5282dbd1 --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenAddedEither(DefaultEcs-EntitySetBuilder_System-Type--).md @@ -0,0 +1,19 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilderExtension](./DefaultEcs-EntitySetBuilderExtension.md 'DefaultEcs.EntitySetBuilderExtension') +## EntitySetBuilderExtension.WhenAddedEither(DefaultEcs.EntitySetBuilder, System.Type[]) Method +Makes a rule to observe [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when one component of the given types is added. +```C# +public static DefaultEcs.EntitySetBuilder WhenAddedEither(this DefaultEcs.EntitySetBuilder builder, params System.Type[] componentTypes); +``` +#### Parameters + +`builder` [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +The [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') on which to create the rule. + + +`componentTypes` [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') +The types of component. + +#### Returns +[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenAddedEither-T1_T2-(DefaultEcs-EntitySetBuilder).md b/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenAddedEither-T1_T2-(DefaultEcs-EntitySetBuilder).md deleted file mode 100644 index d12ce073..00000000 --- a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenAddedEither-T1_T2-(DefaultEcs-EntitySetBuilder).md +++ /dev/null @@ -1,24 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilderExtension](./DefaultEcs-EntitySetBuilderExtension.md 'DefaultEcs.EntitySetBuilderExtension') -## EntitySetBuilderExtension.WhenAddedEither<T1,T2>(DefaultEcs.EntitySetBuilder) Method -Makes a rule to obsverve [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when at least one component of type [T1](#DefaultEcs-EntitySetBuilderExtension-WhenAddedEither-T1_T2-(DefaultEcs-EntitySetBuilder)-T1 'DefaultEcs.EntitySetBuilderExtension.WhenAddedEither<T1,T2>(DefaultEcs.EntitySetBuilder).T1') or [T2](#DefaultEcs-EntitySetBuilderExtension-WhenAddedEither-T1_T2-(DefaultEcs-EntitySetBuilder)-T2 'DefaultEcs.EntitySetBuilderExtension.WhenAddedEither<T1,T2>(DefaultEcs.EntitySetBuilder).T2') is added. -```C# -public static DefaultEcs.EntitySetBuilder WhenAddedEither(this DefaultEcs.EntitySetBuilder builder); -``` -#### Type parameters - -`T1` -The first type of component. - - -`T2` -The second type of component. - -#### Parameters - -`builder` [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') on which to create the rule. - -#### Returns -[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The given [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenAddedEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder).md b/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenAddedEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder).md deleted file mode 100644 index 204b5188..00000000 --- a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenAddedEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder).md +++ /dev/null @@ -1,28 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilderExtension](./DefaultEcs-EntitySetBuilderExtension.md 'DefaultEcs.EntitySetBuilderExtension') -## EntitySetBuilderExtension.WhenAddedEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder) Method -Makes a rule to obsverve [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when at least one component of type [T1](#DefaultEcs-EntitySetBuilderExtension-WhenAddedEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder)-T1 'DefaultEcs.EntitySetBuilderExtension.WhenAddedEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder).T1'), [T2](#DefaultEcs-EntitySetBuilderExtension-WhenAddedEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder)-T2 'DefaultEcs.EntitySetBuilderExtension.WhenAddedEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder).T2') or [T3](#DefaultEcs-EntitySetBuilderExtension-WhenAddedEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder)-T3 'DefaultEcs.EntitySetBuilderExtension.WhenAddedEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder).T3') is added. -```C# -public static DefaultEcs.EntitySetBuilder WhenAddedEither(this DefaultEcs.EntitySetBuilder builder); -``` -#### Type parameters - -`T1` -The first type of component. - - -`T2` -The second type of component. - - -`T3` -The third type of component. - -#### Parameters - -`builder` [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') on which to create the rule. - -#### Returns -[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The given [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenChanged(DefaultEcs-EntitySetBuilder_System-Type--).md b/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenChanged(DefaultEcs-EntitySetBuilder_System-Type--).md new file mode 100644 index 00000000..14665598 --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenChanged(DefaultEcs-EntitySetBuilder_System-Type--).md @@ -0,0 +1,19 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilderExtension](./DefaultEcs-EntitySetBuilderExtension.md 'DefaultEcs.EntitySetBuilderExtension') +## EntitySetBuilderExtension.WhenChanged(DefaultEcs.EntitySetBuilder, System.Type[]) Method +Makes a rule to obsverve [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when all component of the given types are changed. +```C# +public static DefaultEcs.EntitySetBuilder WhenChanged(this DefaultEcs.EntitySetBuilder builder, params System.Type[] componentTypes); +``` +#### Parameters + +`builder` [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +The [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') on which to create the rule. + + +`componentTypes` [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') +The types of component. + +#### Returns +[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenChangedEither(DefaultEcs-EntitySetBuilder_System-Type--).md b/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenChangedEither(DefaultEcs-EntitySetBuilder_System-Type--).md new file mode 100644 index 00000000..db1771ef --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenChangedEither(DefaultEcs-EntitySetBuilder_System-Type--).md @@ -0,0 +1,19 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilderExtension](./DefaultEcs-EntitySetBuilderExtension.md 'DefaultEcs.EntitySetBuilderExtension') +## EntitySetBuilderExtension.WhenChangedEither(DefaultEcs.EntitySetBuilder, System.Type[]) Method +Makes a rule to observe [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when one component of the given types is changed. +```C# +public static DefaultEcs.EntitySetBuilder WhenChangedEither(this DefaultEcs.EntitySetBuilder builder, params System.Type[] componentTypes); +``` +#### Parameters + +`builder` [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +The [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') on which to create the rule. + + +`componentTypes` [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') +The types of component. + +#### Returns +[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenChangedEither-T1_T2-(DefaultEcs-EntitySetBuilder).md b/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenChangedEither-T1_T2-(DefaultEcs-EntitySetBuilder).md deleted file mode 100644 index 13e0b057..00000000 --- a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenChangedEither-T1_T2-(DefaultEcs-EntitySetBuilder).md +++ /dev/null @@ -1,24 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilderExtension](./DefaultEcs-EntitySetBuilderExtension.md 'DefaultEcs.EntitySetBuilderExtension') -## EntitySetBuilderExtension.WhenChangedEither<T1,T2>(DefaultEcs.EntitySetBuilder) Method -Makes a rule to obsverve [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when at least one component of type [T1](#DefaultEcs-EntitySetBuilderExtension-WhenChangedEither-T1_T2-(DefaultEcs-EntitySetBuilder)-T1 'DefaultEcs.EntitySetBuilderExtension.WhenChangedEither<T1,T2>(DefaultEcs.EntitySetBuilder).T1') or [T2](#DefaultEcs-EntitySetBuilderExtension-WhenChangedEither-T1_T2-(DefaultEcs-EntitySetBuilder)-T2 'DefaultEcs.EntitySetBuilderExtension.WhenChangedEither<T1,T2>(DefaultEcs.EntitySetBuilder).T2') is changed. -```C# -public static DefaultEcs.EntitySetBuilder WhenChangedEither(this DefaultEcs.EntitySetBuilder builder); -``` -#### Type parameters - -`T1` -The first type of component. - - -`T2` -The second type of component. - -#### Parameters - -`builder` [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') on which to create the rule. - -#### Returns -[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The given [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenChangedEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder).md b/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenChangedEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder).md deleted file mode 100644 index e5488d13..00000000 --- a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenChangedEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder).md +++ /dev/null @@ -1,28 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilderExtension](./DefaultEcs-EntitySetBuilderExtension.md 'DefaultEcs.EntitySetBuilderExtension') -## EntitySetBuilderExtension.WhenChangedEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder) Method -Makes a rule to obsverve [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when at least one component of type [T1](#DefaultEcs-EntitySetBuilderExtension-WhenChangedEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder)-T1 'DefaultEcs.EntitySetBuilderExtension.WhenChangedEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder).T1'), [T2](#DefaultEcs-EntitySetBuilderExtension-WhenChangedEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder)-T2 'DefaultEcs.EntitySetBuilderExtension.WhenChangedEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder).T2') or [T3](#DefaultEcs-EntitySetBuilderExtension-WhenChangedEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder)-T3 'DefaultEcs.EntitySetBuilderExtension.WhenChangedEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder).T3') is changed. -```C# -public static DefaultEcs.EntitySetBuilder WhenChangedEither(this DefaultEcs.EntitySetBuilder builder); -``` -#### Type parameters - -`T1` -The first type of component. - - -`T2` -The second type of component. - - -`T3` -The third type of component. - -#### Parameters - -`builder` [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') on which to create the rule. - -#### Returns -[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The given [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenRemoved(DefaultEcs-EntitySetBuilder_System-Type--).md b/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenRemoved(DefaultEcs-EntitySetBuilder_System-Type--).md new file mode 100644 index 00000000..a2b7cee7 --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenRemoved(DefaultEcs-EntitySetBuilder_System-Type--).md @@ -0,0 +1,19 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilderExtension](./DefaultEcs-EntitySetBuilderExtension.md 'DefaultEcs.EntitySetBuilderExtension') +## EntitySetBuilderExtension.WhenRemoved(DefaultEcs.EntitySetBuilder, System.Type[]) Method +Makes a rule to obsverve [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when all component of the given types are removed. +```C# +public static DefaultEcs.EntitySetBuilder WhenRemoved(this DefaultEcs.EntitySetBuilder builder, params System.Type[] componentTypes); +``` +#### Parameters + +`builder` [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +The [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') on which to create the rule. + + +`componentTypes` [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') +The types of component. + +#### Returns +[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenRemovedEither(DefaultEcs-EntitySetBuilder_System-Type--).md b/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenRemovedEither(DefaultEcs-EntitySetBuilder_System-Type--).md new file mode 100644 index 00000000..50a502c2 --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenRemovedEither(DefaultEcs-EntitySetBuilder_System-Type--).md @@ -0,0 +1,19 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilderExtension](./DefaultEcs-EntitySetBuilderExtension.md 'DefaultEcs.EntitySetBuilderExtension') +## EntitySetBuilderExtension.WhenRemovedEither(DefaultEcs.EntitySetBuilder, System.Type[]) Method +Makes a rule to observe [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when one component of the given types is removed. +```C# +public static DefaultEcs.EntitySetBuilder WhenRemovedEither(this DefaultEcs.EntitySetBuilder builder, params System.Type[] componentTypes); +``` +#### Parameters + +`builder` [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +The [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') on which to create the rule. + + +`componentTypes` [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') +The types of component. + +#### Returns +[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenRemovedEither-T1_T2-(DefaultEcs-EntitySetBuilder).md b/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenRemovedEither-T1_T2-(DefaultEcs-EntitySetBuilder).md deleted file mode 100644 index 9c853a0f..00000000 --- a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenRemovedEither-T1_T2-(DefaultEcs-EntitySetBuilder).md +++ /dev/null @@ -1,24 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilderExtension](./DefaultEcs-EntitySetBuilderExtension.md 'DefaultEcs.EntitySetBuilderExtension') -## EntitySetBuilderExtension.WhenRemovedEither<T1,T2>(DefaultEcs.EntitySetBuilder) Method -Makes a rule to obsverve [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when at least one component of type [T1](#DefaultEcs-EntitySetBuilderExtension-WhenRemovedEither-T1_T2-(DefaultEcs-EntitySetBuilder)-T1 'DefaultEcs.EntitySetBuilderExtension.WhenRemovedEither<T1,T2>(DefaultEcs.EntitySetBuilder).T1') or [T2](#DefaultEcs-EntitySetBuilderExtension-WhenRemovedEither-T1_T2-(DefaultEcs-EntitySetBuilder)-T2 'DefaultEcs.EntitySetBuilderExtension.WhenRemovedEither<T1,T2>(DefaultEcs.EntitySetBuilder).T2') is removed. -```C# -public static DefaultEcs.EntitySetBuilder WhenRemovedEither(this DefaultEcs.EntitySetBuilder builder); -``` -#### Type parameters - -`T1` -The first type of component. - - -`T2` -The second type of component. - -#### Parameters - -`builder` [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') on which to create the rule. - -#### Returns -[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The given [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenRemovedEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder).md b/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenRemovedEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder).md deleted file mode 100644 index 586cc74b..00000000 --- a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WhenRemovedEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder).md +++ /dev/null @@ -1,28 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilderExtension](./DefaultEcs-EntitySetBuilderExtension.md 'DefaultEcs.EntitySetBuilderExtension') -## EntitySetBuilderExtension.WhenRemovedEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder) Method -Makes a rule to obsverve [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when at least one component of type [T1](#DefaultEcs-EntitySetBuilderExtension-WhenRemovedEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder)-T1 'DefaultEcs.EntitySetBuilderExtension.WhenRemovedEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder).T1'), [T2](#DefaultEcs-EntitySetBuilderExtension-WhenRemovedEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder)-T2 'DefaultEcs.EntitySetBuilderExtension.WhenRemovedEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder).T2') or [T3](#DefaultEcs-EntitySetBuilderExtension-WhenRemovedEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder)-T3 'DefaultEcs.EntitySetBuilderExtension.WhenRemovedEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder).T3') is removed. -```C# -public static DefaultEcs.EntitySetBuilder WhenRemovedEither(this DefaultEcs.EntitySetBuilder builder); -``` -#### Type parameters - -`T1` -The first type of component. - - -`T2` -The second type of component. - - -`T3` -The third type of component. - -#### Parameters - -`builder` [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') on which to create the rule. - -#### Returns -[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The given [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilderExtension-With(DefaultEcs-EntitySetBuilder_System-Type--).md b/documentation/api/DefaultEcs-EntitySetBuilderExtension-With(DefaultEcs-EntitySetBuilder_System-Type--).md new file mode 100644 index 00000000..5e85f699 --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilderExtension-With(DefaultEcs-EntitySetBuilder_System-Type--).md @@ -0,0 +1,19 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilderExtension](./DefaultEcs-EntitySetBuilderExtension.md 'DefaultEcs.EntitySetBuilderExtension') +## EntitySetBuilderExtension.With(DefaultEcs.EntitySetBuilder, System.Type[]) Method +Makes a rule to obsverve [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') with all component of the given types. +```C# +public static DefaultEcs.EntitySetBuilder With(this DefaultEcs.EntitySetBuilder builder, params System.Type[] componentTypes); +``` +#### Parameters + +`builder` [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +The [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') on which to create the rule. + + +`componentTypes` [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') +The types of component. + +#### Returns +[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WithEither(DefaultEcs-EntitySetBuilder_System-Type--).md b/documentation/api/DefaultEcs-EntitySetBuilderExtension-WithEither(DefaultEcs-EntitySetBuilder_System-Type--).md new file mode 100644 index 00000000..d2ff82e3 --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilderExtension-WithEither(DefaultEcs-EntitySetBuilder_System-Type--).md @@ -0,0 +1,19 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilderExtension](./DefaultEcs-EntitySetBuilderExtension.md 'DefaultEcs.EntitySetBuilderExtension') +## EntitySetBuilderExtension.WithEither(DefaultEcs.EntitySetBuilder, System.Type[]) Method +Makes a rule to obsverve [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') with at least one component of the given types. +```C# +public static DefaultEcs.EntitySetBuilder WithEither(this DefaultEcs.EntitySetBuilder builder, params System.Type[] componentTypes); +``` +#### Parameters + +`builder` [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +The [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') on which to create the rule. + + +`componentTypes` [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') +The types of component. + +#### Returns +[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WithEither-T1_T2-(DefaultEcs-EntitySetBuilder).md b/documentation/api/DefaultEcs-EntitySetBuilderExtension-WithEither-T1_T2-(DefaultEcs-EntitySetBuilder).md deleted file mode 100644 index 00d94bdc..00000000 --- a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WithEither-T1_T2-(DefaultEcs-EntitySetBuilder).md +++ /dev/null @@ -1,24 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilderExtension](./DefaultEcs-EntitySetBuilderExtension.md 'DefaultEcs.EntitySetBuilderExtension') -## EntitySetBuilderExtension.WithEither<T1,T2>(DefaultEcs.EntitySetBuilder) Method -Makes a rule to obsverve [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') with at least one component of type [T1](#DefaultEcs-EntitySetBuilderExtension-WithEither-T1_T2-(DefaultEcs-EntitySetBuilder)-T1 'DefaultEcs.EntitySetBuilderExtension.WithEither<T1,T2>(DefaultEcs.EntitySetBuilder).T1') or [T2](#DefaultEcs-EntitySetBuilderExtension-WithEither-T1_T2-(DefaultEcs-EntitySetBuilder)-T2 'DefaultEcs.EntitySetBuilderExtension.WithEither<T1,T2>(DefaultEcs.EntitySetBuilder).T2'). -```C# -public static DefaultEcs.EntitySetBuilder WithEither(this DefaultEcs.EntitySetBuilder builder); -``` -#### Type parameters - -`T1` -The first type of component. - - -`T2` -The second type of component. - -#### Parameters - -`builder` [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') on which to create the rule. - -#### Returns -[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The given [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WithEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder).md b/documentation/api/DefaultEcs-EntitySetBuilderExtension-WithEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder).md deleted file mode 100644 index 454027de..00000000 --- a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WithEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder).md +++ /dev/null @@ -1,28 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilderExtension](./DefaultEcs-EntitySetBuilderExtension.md 'DefaultEcs.EntitySetBuilderExtension') -## EntitySetBuilderExtension.WithEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder) Method -Makes a rule to obsverve [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') with at least one component of type [T1](#DefaultEcs-EntitySetBuilderExtension-WithEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder)-T1 'DefaultEcs.EntitySetBuilderExtension.WithEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder).T1'), [T2](#DefaultEcs-EntitySetBuilderExtension-WithEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder)-T2 'DefaultEcs.EntitySetBuilderExtension.WithEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder).T2') or [T3](#DefaultEcs-EntitySetBuilderExtension-WithEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder)-T3 'DefaultEcs.EntitySetBuilderExtension.WithEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder).T3'). -```C# -public static DefaultEcs.EntitySetBuilder WithEither(this DefaultEcs.EntitySetBuilder builder); -``` -#### Type parameters - -`T1` -The first type of component. - - -`T2` -The second type of component. - - -`T3` -The third type of component. - -#### Parameters - -`builder` [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') on which to create the rule. - -#### Returns -[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The given [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilderExtension-Without(DefaultEcs-EntitySetBuilder_System-Type--).md b/documentation/api/DefaultEcs-EntitySetBuilderExtension-Without(DefaultEcs-EntitySetBuilder_System-Type--).md new file mode 100644 index 00000000..c9849079 --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilderExtension-Without(DefaultEcs-EntitySetBuilder_System-Type--).md @@ -0,0 +1,19 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilderExtension](./DefaultEcs-EntitySetBuilderExtension.md 'DefaultEcs.EntitySetBuilderExtension') +## EntitySetBuilderExtension.Without(DefaultEcs.EntitySetBuilder, System.Type[]) Method +Makes a rule to ignore [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') with at least one component of the given types. +```C# +public static DefaultEcs.EntitySetBuilder Without(this DefaultEcs.EntitySetBuilder builder, params System.Type[] componentTypes); +``` +#### Parameters + +`builder` [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +The [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') on which to create the rule. + + +`componentTypes` [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') +The types of component. + +#### Returns +[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WithoutEither(DefaultEcs-EntitySetBuilder_System-Type--).md b/documentation/api/DefaultEcs-EntitySetBuilderExtension-WithoutEither(DefaultEcs-EntitySetBuilder_System-Type--).md new file mode 100644 index 00000000..512c23a0 --- /dev/null +++ b/documentation/api/DefaultEcs-EntitySetBuilderExtension-WithoutEither(DefaultEcs-EntitySetBuilder_System-Type--).md @@ -0,0 +1,19 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilderExtension](./DefaultEcs-EntitySetBuilderExtension.md 'DefaultEcs.EntitySetBuilderExtension') +## EntitySetBuilderExtension.WithoutEither(DefaultEcs.EntitySetBuilder, System.Type[]) Method +Makes a rule to obsverve [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') without at least one component of the given types. +```C# +public static DefaultEcs.EntitySetBuilder WithoutEither(this DefaultEcs.EntitySetBuilder builder, params System.Type[] componentTypes); +``` +#### Parameters + +`builder` [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +The [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') on which to create the rule. + + +`componentTypes` [System.Type](https://docs.microsoft.com/en-us/dotnet/api/System.Type 'System.Type')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') +The types of component. + +#### Returns +[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WithoutEither-T1_T2-(DefaultEcs-EntitySetBuilder).md b/documentation/api/DefaultEcs-EntitySetBuilderExtension-WithoutEither-T1_T2-(DefaultEcs-EntitySetBuilder).md deleted file mode 100644 index 200042ab..00000000 --- a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WithoutEither-T1_T2-(DefaultEcs-EntitySetBuilder).md +++ /dev/null @@ -1,24 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilderExtension](./DefaultEcs-EntitySetBuilderExtension.md 'DefaultEcs.EntitySetBuilderExtension') -## EntitySetBuilderExtension.WithoutEither<T1,T2>(DefaultEcs.EntitySetBuilder) Method -Makes a rule to obsverve [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') without at least one component of type [T1](#DefaultEcs-EntitySetBuilderExtension-WithoutEither-T1_T2-(DefaultEcs-EntitySetBuilder)-T1 'DefaultEcs.EntitySetBuilderExtension.WithoutEither<T1,T2>(DefaultEcs.EntitySetBuilder).T1') or [T2](#DefaultEcs-EntitySetBuilderExtension-WithoutEither-T1_T2-(DefaultEcs-EntitySetBuilder)-T2 'DefaultEcs.EntitySetBuilderExtension.WithoutEither<T1,T2>(DefaultEcs.EntitySetBuilder).T2'). -```C# -public static DefaultEcs.EntitySetBuilder WithoutEither(this DefaultEcs.EntitySetBuilder builder); -``` -#### Type parameters - -`T1` -The first type of component. - - -`T2` -The second type of component. - -#### Parameters - -`builder` [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') on which to create the rule. - -#### Returns -[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The given [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WithoutEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder).md b/documentation/api/DefaultEcs-EntitySetBuilderExtension-WithoutEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder).md deleted file mode 100644 index 198f08dc..00000000 --- a/documentation/api/DefaultEcs-EntitySetBuilderExtension-WithoutEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder).md +++ /dev/null @@ -1,28 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[EntitySetBuilderExtension](./DefaultEcs-EntitySetBuilderExtension.md 'DefaultEcs.EntitySetBuilderExtension') -## EntitySetBuilderExtension.WithoutEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder) Method -Makes a rule to obsverve [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') without at least one component of type [T1](#DefaultEcs-EntitySetBuilderExtension-WithoutEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder)-T1 'DefaultEcs.EntitySetBuilderExtension.WithoutEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder).T1'), [T2](#DefaultEcs-EntitySetBuilderExtension-WithoutEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder)-T2 'DefaultEcs.EntitySetBuilderExtension.WithoutEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder).T2') or [T3](#DefaultEcs-EntitySetBuilderExtension-WithoutEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder)-T3 'DefaultEcs.EntitySetBuilderExtension.WithoutEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder).T3'). -```C# -public static DefaultEcs.EntitySetBuilder WithoutEither(this DefaultEcs.EntitySetBuilder builder); -``` -#### Type parameters - -`T1` -The first type of component. - - -`T2` -The second type of component. - - -`T3` -The third type of component. - -#### Parameters - -`builder` [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') on which to create the rule. - -#### Returns -[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') -The given [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-EntitySetBuilderExtension.md b/documentation/api/DefaultEcs-EntitySetBuilderExtension.md index f44b26ec..c9b55a99 100644 --- a/documentation/api/DefaultEcs-EntitySetBuilderExtension.md +++ b/documentation/api/DefaultEcs-EntitySetBuilderExtension.md @@ -7,13 +7,13 @@ public static class EntitySetBuilderExtension ``` Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') > [EntitySetBuilderExtension](./DefaultEcs-EntitySetBuilderExtension.md 'DefaultEcs.EntitySetBuilderExtension') ### Methods -- [WhenAddedEither<T1,T2>(DefaultEcs.EntitySetBuilder)](./DefaultEcs-EntitySetBuilderExtension-WhenAddedEither-T1_T2-(DefaultEcs-EntitySetBuilder).md 'DefaultEcs.EntitySetBuilderExtension.WhenAddedEither<T1,T2>(DefaultEcs.EntitySetBuilder)') -- [WhenAddedEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder)](./DefaultEcs-EntitySetBuilderExtension-WhenAddedEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder).md 'DefaultEcs.EntitySetBuilderExtension.WhenAddedEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder)') -- [WhenChangedEither<T1,T2>(DefaultEcs.EntitySetBuilder)](./DefaultEcs-EntitySetBuilderExtension-WhenChangedEither-T1_T2-(DefaultEcs-EntitySetBuilder).md 'DefaultEcs.EntitySetBuilderExtension.WhenChangedEither<T1,T2>(DefaultEcs.EntitySetBuilder)') -- [WhenChangedEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder)](./DefaultEcs-EntitySetBuilderExtension-WhenChangedEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder).md 'DefaultEcs.EntitySetBuilderExtension.WhenChangedEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder)') -- [WhenRemovedEither<T1,T2>(DefaultEcs.EntitySetBuilder)](./DefaultEcs-EntitySetBuilderExtension-WhenRemovedEither-T1_T2-(DefaultEcs-EntitySetBuilder).md 'DefaultEcs.EntitySetBuilderExtension.WhenRemovedEither<T1,T2>(DefaultEcs.EntitySetBuilder)') -- [WhenRemovedEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder)](./DefaultEcs-EntitySetBuilderExtension-WhenRemovedEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder).md 'DefaultEcs.EntitySetBuilderExtension.WhenRemovedEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder)') -- [WithEither<T1,T2>(DefaultEcs.EntitySetBuilder)](./DefaultEcs-EntitySetBuilderExtension-WithEither-T1_T2-(DefaultEcs-EntitySetBuilder).md 'DefaultEcs.EntitySetBuilderExtension.WithEither<T1,T2>(DefaultEcs.EntitySetBuilder)') -- [WithEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder)](./DefaultEcs-EntitySetBuilderExtension-WithEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder).md 'DefaultEcs.EntitySetBuilderExtension.WithEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder)') -- [WithoutEither<T1,T2>(DefaultEcs.EntitySetBuilder)](./DefaultEcs-EntitySetBuilderExtension-WithoutEither-T1_T2-(DefaultEcs-EntitySetBuilder).md 'DefaultEcs.EntitySetBuilderExtension.WithoutEither<T1,T2>(DefaultEcs.EntitySetBuilder)') -- [WithoutEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder)](./DefaultEcs-EntitySetBuilderExtension-WithoutEither-T1_T2_T3-(DefaultEcs-EntitySetBuilder).md 'DefaultEcs.EntitySetBuilderExtension.WithoutEither<T1,T2,T3>(DefaultEcs.EntitySetBuilder)') +- [WhenAdded(DefaultEcs.EntitySetBuilder, System.Type[])](./DefaultEcs-EntitySetBuilderExtension-WhenAdded(DefaultEcs-EntitySetBuilder_System-Type--).md 'DefaultEcs.EntitySetBuilderExtension.WhenAdded(DefaultEcs.EntitySetBuilder, System.Type[])') +- [WhenAddedEither(DefaultEcs.EntitySetBuilder, System.Type[])](./DefaultEcs-EntitySetBuilderExtension-WhenAddedEither(DefaultEcs-EntitySetBuilder_System-Type--).md 'DefaultEcs.EntitySetBuilderExtension.WhenAddedEither(DefaultEcs.EntitySetBuilder, System.Type[])') +- [WhenChanged(DefaultEcs.EntitySetBuilder, System.Type[])](./DefaultEcs-EntitySetBuilderExtension-WhenChanged(DefaultEcs-EntitySetBuilder_System-Type--).md 'DefaultEcs.EntitySetBuilderExtension.WhenChanged(DefaultEcs.EntitySetBuilder, System.Type[])') +- [WhenChangedEither(DefaultEcs.EntitySetBuilder, System.Type[])](./DefaultEcs-EntitySetBuilderExtension-WhenChangedEither(DefaultEcs-EntitySetBuilder_System-Type--).md 'DefaultEcs.EntitySetBuilderExtension.WhenChangedEither(DefaultEcs.EntitySetBuilder, System.Type[])') +- [WhenRemoved(DefaultEcs.EntitySetBuilder, System.Type[])](./DefaultEcs-EntitySetBuilderExtension-WhenRemoved(DefaultEcs-EntitySetBuilder_System-Type--).md 'DefaultEcs.EntitySetBuilderExtension.WhenRemoved(DefaultEcs.EntitySetBuilder, System.Type[])') +- [WhenRemovedEither(DefaultEcs.EntitySetBuilder, System.Type[])](./DefaultEcs-EntitySetBuilderExtension-WhenRemovedEither(DefaultEcs-EntitySetBuilder_System-Type--).md 'DefaultEcs.EntitySetBuilderExtension.WhenRemovedEither(DefaultEcs.EntitySetBuilder, System.Type[])') +- [With(DefaultEcs.EntitySetBuilder, System.Type[])](./DefaultEcs-EntitySetBuilderExtension-With(DefaultEcs-EntitySetBuilder_System-Type--).md 'DefaultEcs.EntitySetBuilderExtension.With(DefaultEcs.EntitySetBuilder, System.Type[])') +- [WithEither(DefaultEcs.EntitySetBuilder, System.Type[])](./DefaultEcs-EntitySetBuilderExtension-WithEither(DefaultEcs-EntitySetBuilder_System-Type--).md 'DefaultEcs.EntitySetBuilderExtension.WithEither(DefaultEcs.EntitySetBuilder, System.Type[])') +- [Without(DefaultEcs.EntitySetBuilder, System.Type[])](./DefaultEcs-EntitySetBuilderExtension-Without(DefaultEcs-EntitySetBuilder_System-Type--).md 'DefaultEcs.EntitySetBuilderExtension.Without(DefaultEcs.EntitySetBuilder, System.Type[])') +- [WithoutEither(DefaultEcs.EntitySetBuilder, System.Type[])](./DefaultEcs-EntitySetBuilderExtension-WithoutEither(DefaultEcs-EntitySetBuilder_System-Type--).md 'DefaultEcs.EntitySetBuilderExtension.WithoutEither(DefaultEcs.EntitySetBuilder, System.Type[])') diff --git a/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent--AComponentSystem(DefaultEcs-World_DefaultEcs-System-SystemRunner-TState-).md b/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent--AComponentSystem(DefaultEcs-World_DefaultEcs-System-SystemRunner-TState-).md deleted file mode 100644 index 731defa4..00000000 --- a/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent--AComponentSystem(DefaultEcs-World_DefaultEcs-System-SystemRunner-TState-).md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[AComponentSystem<TState,TComponent>](./DefaultEcs-System-AComponentSystem-TState_TComponent-.md 'DefaultEcs.System.AComponentSystem<TState,TComponent>') -## AComponentSystem(DefaultEcs.World, DefaultEcs.System.SystemRunner<TState>) Constructor -Initialise a new instance of the [AComponentSystem<TState,TComponent>](./DefaultEcs-System-AComponentSystem-TState_TComponent-.md 'DefaultEcs.System.AComponentSystem<TState,TComponent>') class with the given [World](./DefaultEcs-World.md 'DefaultEcs.World') and [SystemRunner<T>](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>'). -```C# -protected AComponentSystem(DefaultEcs.World world, DefaultEcs.System.SystemRunner runner); -``` -#### Parameters - -`world` [World](./DefaultEcs-World.md 'DefaultEcs.World') -The [World](./DefaultEcs-World.md 'DefaultEcs.World') on which to process the update. - - -`runner` [DefaultEcs.System.SystemRunner<](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>')[TState](./DefaultEcs-System-AComponentSystem-TState_TComponent-.md#DefaultEcs-System-AComponentSystem-TState_TComponent--TState 'DefaultEcs.System.AComponentSystem<TState,TComponent>.TState')[>](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>') -The [SystemRunner<T>](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>') used to process the update in parallel if not null. - -#### Exceptions -[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') -[world](#DefaultEcs-System-AComponentSystem-TState_TComponent--AComponentSystem(DefaultEcs-World_DefaultEcs-System-SystemRunner-TState-)-world 'DefaultEcs.System.AComponentSystem<TState,TComponent>.AComponentSystem(DefaultEcs.World, DefaultEcs.System.SystemRunner<TState>).world') is null. diff --git a/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent--AComponentSystem(DefaultEcs-World_DefaultEcs-Threading-IParallelRunner).md b/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent--AComponentSystem(DefaultEcs-World_DefaultEcs-Threading-IParallelRunner).md new file mode 100644 index 00000000..e59add5e --- /dev/null +++ b/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent--AComponentSystem(DefaultEcs-World_DefaultEcs-Threading-IParallelRunner).md @@ -0,0 +1,19 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[AComponentSystem<TState,TComponent>](./DefaultEcs-System-AComponentSystem-TState_TComponent-.md 'DefaultEcs.System.AComponentSystem<TState,TComponent>') +## AComponentSystem(DefaultEcs.World, DefaultEcs.Threading.IParallelRunner) Constructor +Initialise a new instance of the [AComponentSystem<TState,TComponent>](./DefaultEcs-System-AComponentSystem-TState_TComponent-.md 'DefaultEcs.System.AComponentSystem<TState,TComponent>') class with the given [World](./DefaultEcs-World.md 'DefaultEcs.World') and [IParallelRunner](./DefaultEcs-Threading-IParallelRunner.md 'DefaultEcs.Threading.IParallelRunner'). +```C# +protected AComponentSystem(DefaultEcs.World world, DefaultEcs.Threading.IParallelRunner runner); +``` +#### Parameters + +`world` [World](./DefaultEcs-World.md 'DefaultEcs.World') +The [World](./DefaultEcs-World.md 'DefaultEcs.World') on which to process the update. + + +`runner` [IParallelRunner](./DefaultEcs-Threading-IParallelRunner.md 'DefaultEcs.Threading.IParallelRunner') +The [IParallelRunner](./DefaultEcs-Threading-IParallelRunner.md 'DefaultEcs.Threading.IParallelRunner') used to process the update in parallel if not null. + +#### Exceptions +[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') +[world](#DefaultEcs-System-AComponentSystem-TState_TComponent--AComponentSystem(DefaultEcs-World_DefaultEcs-Threading-IParallelRunner)-world 'DefaultEcs.System.AComponentSystem<TState,TComponent>.AComponentSystem(DefaultEcs.World, DefaultEcs.Threading.IParallelRunner).world') is null. diff --git a/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent--Dispose().md b/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent--Dispose().md index 8f9efe37..2b6349a5 100644 --- a/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent--Dispose().md +++ b/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent--Dispose().md @@ -3,5 +3,5 @@ ## AComponentSystem<TState,TComponent>.Dispose() Method Does nothing. ```C# -public override void Dispose(); +public virtual void Dispose(); ``` diff --git a/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent--IsEnabled.md b/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent--IsEnabled.md index 2d94e53c..75ed10d3 100644 --- a/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent--IsEnabled.md +++ b/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent--IsEnabled.md @@ -2,9 +2,8 @@ ### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[AComponentSystem<TState,TComponent>](./DefaultEcs-System-AComponentSystem-TState_TComponent-.md 'DefaultEcs.System.AComponentSystem<TState,TComponent>') ## AComponentSystem<TState,TComponent>.IsEnabled Property Gets or sets whether the current [AComponentSystem<TState,TComponent>](./DefaultEcs-System-AComponentSystem-TState_TComponent-.md 'DefaultEcs.System.AComponentSystem<TState,TComponent>') instance should update or not. -Will return false if there is no component to update. ```C# -public sealed override bool IsEnabled { get; set; } +public bool IsEnabled { get; set; } ``` #### Returns [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') diff --git a/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent--PostUpdate(TState).md b/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent--PostUpdate(TState).md new file mode 100644 index 00000000..f29b0474 --- /dev/null +++ b/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent--PostUpdate(TState).md @@ -0,0 +1,12 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[AComponentSystem<TState,TComponent>](./DefaultEcs-System-AComponentSystem-TState_TComponent-.md 'DefaultEcs.System.AComponentSystem<TState,TComponent>') +## AComponentSystem<TState,TComponent>.PostUpdate(TState) Method +Performs a post-update treatment. +```C# +protected virtual void PostUpdate(TState state); +``` +#### Parameters + +`state` [TState](./DefaultEcs-System-AComponentSystem-TState_TComponent-.md#DefaultEcs-System-AComponentSystem-TState_TComponent--TState 'DefaultEcs.System.AComponentSystem<TState,TComponent>.TState') +The state to use. + diff --git a/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent--PreUpdate(TState).md b/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent--PreUpdate(TState).md new file mode 100644 index 00000000..f596b9d1 --- /dev/null +++ b/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent--PreUpdate(TState).md @@ -0,0 +1,12 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[AComponentSystem<TState,TComponent>](./DefaultEcs-System-AComponentSystem-TState_TComponent-.md 'DefaultEcs.System.AComponentSystem<TState,TComponent>') +## AComponentSystem<TState,TComponent>.PreUpdate(TState) Method +Performs a pre-update treatment. +```C# +protected virtual void PreUpdate(TState state); +``` +#### Parameters + +`state` [TState](./DefaultEcs-System-AComponentSystem-TState_TComponent-.md#DefaultEcs-System-AComponentSystem-TState_TComponent--TState 'DefaultEcs.System.AComponentSystem<TState,TComponent>.TState') +The state to use. + diff --git a/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent--Update(TState).md b/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent--Update(TState).md new file mode 100644 index 00000000..e640a342 --- /dev/null +++ b/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent--Update(TState).md @@ -0,0 +1,13 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[AComponentSystem<TState,TComponent>](./DefaultEcs-System-AComponentSystem-TState_TComponent-.md 'DefaultEcs.System.AComponentSystem<TState,TComponent>') +## AComponentSystem<TState,TComponent>.Update(TState) Method +Updates the system once. +Does nothing if [IsEnabled](./DefaultEcs-System-AComponentSystem-TState_TComponent--IsEnabled.md 'DefaultEcs.System.AComponentSystem<TState,TComponent>.IsEnabled') is false or if there is no component of type [TComponent](./DefaultEcs-System-AComponentSystem-TState_TComponent-.md#DefaultEcs-System-AComponentSystem-TState_TComponent--TComponent 'DefaultEcs.System.AComponentSystem<TState,TComponent>.TComponent') in the [World](./DefaultEcs-World.md 'DefaultEcs.World'). +```C# +public void Update(TState state); +``` +#### Parameters + +`state` [TState](./DefaultEcs-System-AComponentSystem-TState_TComponent-.md#DefaultEcs-System-AComponentSystem-TState_TComponent--TState 'DefaultEcs.System.AComponentSystem<TState,TComponent>.TState') +The state to use. + diff --git a/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent-.md b/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent-.md index 0d48d645..c560d0d8 100644 --- a/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent-.md +++ b/documentation/api/DefaultEcs-System-AComponentSystem-TState_TComponent-.md @@ -3,9 +3,13 @@ ## AComponentSystem<TState,TComponent> Class Represents a base class to process updates on a given [World](./DefaultEcs-World.md 'DefaultEcs.World') instance to all its components of type [TComponent](#DefaultEcs-System-AComponentSystem-TState_TComponent--TComponent 'DefaultEcs.System.AComponentSystem<TState,TComponent>.TComponent'). ```C# -public abstract class AComponentSystem : ASystem +public abstract class AComponentSystem : +ISystem, +IDisposable ``` -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') > [DefaultEcs.System.ASystem<](./DefaultEcs-System-ASystem-T-.md 'DefaultEcs.System.ASystem<T>')[TState](#DefaultEcs-System-AComponentSystem-TState_TComponent--TState 'DefaultEcs.System.AComponentSystem<TState,TComponent>.TState')[>](./DefaultEcs-System-ASystem-T-.md 'DefaultEcs.System.ASystem<T>') > [AComponentSystem<TState,TComponent>](./DefaultEcs-System-AComponentSystem-TState_TComponent-.md 'DefaultEcs.System.AComponentSystem<TState,TComponent>') +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') > [AComponentSystem<TState,TComponent>](./DefaultEcs-System-AComponentSystem-TState_TComponent-.md 'DefaultEcs.System.AComponentSystem<TState,TComponent>') + +Implements [DefaultEcs.System.ISystem<](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>')[TState](#DefaultEcs-System-AComponentSystem-TState_TComponent--TState 'DefaultEcs.System.AComponentSystem<TState,TComponent>.TState')[>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>'), [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable 'System.IDisposable') #### Type parameters `TState` @@ -17,10 +21,13 @@ The type of component to update. ### Constructors - [AComponentSystem(DefaultEcs.World)](./DefaultEcs-System-AComponentSystem-TState_TComponent--AComponentSystem(DefaultEcs-World).md 'DefaultEcs.System.AComponentSystem<TState,TComponent>.AComponentSystem(DefaultEcs.World)') -- [AComponentSystem(DefaultEcs.World, DefaultEcs.System.SystemRunner<TState>)](./DefaultEcs-System-AComponentSystem-TState_TComponent--AComponentSystem(DefaultEcs-World_DefaultEcs-System-SystemRunner-TState-).md 'DefaultEcs.System.AComponentSystem<TState,TComponent>.AComponentSystem(DefaultEcs.World, DefaultEcs.System.SystemRunner<TState>)') +- [AComponentSystem(DefaultEcs.World, DefaultEcs.Threading.IParallelRunner)](./DefaultEcs-System-AComponentSystem-TState_TComponent--AComponentSystem(DefaultEcs-World_DefaultEcs-Threading-IParallelRunner).md 'DefaultEcs.System.AComponentSystem<TState,TComponent>.AComponentSystem(DefaultEcs.World, DefaultEcs.Threading.IParallelRunner)') ### Properties - [IsEnabled](./DefaultEcs-System-AComponentSystem-TState_TComponent--IsEnabled.md 'DefaultEcs.System.AComponentSystem<TState,TComponent>.IsEnabled') ### Methods - [Dispose()](./DefaultEcs-System-AComponentSystem-TState_TComponent--Dispose().md 'DefaultEcs.System.AComponentSystem<TState,TComponent>.Dispose()') +- [PostUpdate(TState)](./DefaultEcs-System-AComponentSystem-TState_TComponent--PostUpdate(TState).md 'DefaultEcs.System.AComponentSystem<TState,TComponent>.PostUpdate(TState)') +- [PreUpdate(TState)](./DefaultEcs-System-AComponentSystem-TState_TComponent--PreUpdate(TState).md 'DefaultEcs.System.AComponentSystem<TState,TComponent>.PreUpdate(TState)') +- [Update(TState)](./DefaultEcs-System-AComponentSystem-TState_TComponent--Update(TState).md 'DefaultEcs.System.AComponentSystem<TState,TComponent>.Update(TState)') - [Update(TState, TComponent)](./DefaultEcs-System-AComponentSystem-TState_TComponent--Update(TState_TComponent).md 'DefaultEcs.System.AComponentSystem<TState,TComponent>.Update(TState, TComponent)') - [Update(TState, System.Span<TComponent>)](./DefaultEcs-System-AComponentSystem-TState_TComponent--Update(TState_System-Span-TComponent-).md 'DefaultEcs.System.AComponentSystem<TState,TComponent>.Update(TState, System.Span<TComponent>)') diff --git a/documentation/api/DefaultEcs-System-AEntitySystem-T--AEntitySystem(DefaultEcs-EntitySet_DefaultEcs-System-SystemRunner-T-).md b/documentation/api/DefaultEcs-System-AEntitySystem-T--AEntitySystem(DefaultEcs-EntitySet_DefaultEcs-System-SystemRunner-T-).md deleted file mode 100644 index 3d92c037..00000000 --- a/documentation/api/DefaultEcs-System-AEntitySystem-T--AEntitySystem(DefaultEcs-EntitySet_DefaultEcs-System-SystemRunner-T-).md +++ /dev/null @@ -1,19 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[AEntitySystem<T>](./DefaultEcs-System-AEntitySystem-T-.md 'DefaultEcs.System.AEntitySystem<T>') -## AEntitySystem(DefaultEcs.EntitySet, DefaultEcs.System.SystemRunner<T>) Constructor -Initialise a new instance of the [AEntitySystem<T>](./DefaultEcs-System-AEntitySystem-T-.md 'DefaultEcs.System.AEntitySystem<T>') class with the given [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet') and [SystemRunner<T>](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>'). -```C# -protected AEntitySystem(DefaultEcs.EntitySet set, DefaultEcs.System.SystemRunner runner); -``` -#### Parameters - -`set` [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet') -The [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet') on which to process the update. - - -`runner` [DefaultEcs.System.SystemRunner<](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>')[T](./DefaultEcs-System-AEntitySystem-T-.md#DefaultEcs-System-AEntitySystem-T--T 'DefaultEcs.System.AEntitySystem<T>.T')[>](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>') -The [SystemRunner<T>](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>') used to process the update in parallel if not null. - -#### Exceptions -[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') -[set](#DefaultEcs-System-AEntitySystem-T--AEntitySystem(DefaultEcs-EntitySet_DefaultEcs-System-SystemRunner-T-)-set 'DefaultEcs.System.AEntitySystem<T>.AEntitySystem(DefaultEcs.EntitySet, DefaultEcs.System.SystemRunner<T>).set') is null. diff --git a/documentation/api/DefaultEcs-System-AEntitySystem-T--AEntitySystem(DefaultEcs-EntitySet_DefaultEcs-Threading-IParallelRunner).md b/documentation/api/DefaultEcs-System-AEntitySystem-T--AEntitySystem(DefaultEcs-EntitySet_DefaultEcs-Threading-IParallelRunner).md new file mode 100644 index 00000000..3a9c8420 --- /dev/null +++ b/documentation/api/DefaultEcs-System-AEntitySystem-T--AEntitySystem(DefaultEcs-EntitySet_DefaultEcs-Threading-IParallelRunner).md @@ -0,0 +1,19 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[AEntitySystem<T>](./DefaultEcs-System-AEntitySystem-T-.md 'DefaultEcs.System.AEntitySystem<T>') +## AEntitySystem(DefaultEcs.EntitySet, DefaultEcs.Threading.IParallelRunner) Constructor +Initialise a new instance of the [AEntitySystem<T>](./DefaultEcs-System-AEntitySystem-T-.md 'DefaultEcs.System.AEntitySystem<T>') class with the given [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet') and [IParallelRunner](./DefaultEcs-Threading-IParallelRunner.md 'DefaultEcs.Threading.IParallelRunner'). +```C# +protected AEntitySystem(DefaultEcs.EntitySet set, DefaultEcs.Threading.IParallelRunner runner); +``` +#### Parameters + +`set` [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet') +The [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet') on which to process the update. + + +`runner` [IParallelRunner](./DefaultEcs-Threading-IParallelRunner.md 'DefaultEcs.Threading.IParallelRunner') +The [IParallelRunner](./DefaultEcs-Threading-IParallelRunner.md 'DefaultEcs.Threading.IParallelRunner') used to process the update in parallel if not null. + +#### Exceptions +[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') +[set](#DefaultEcs-System-AEntitySystem-T--AEntitySystem(DefaultEcs-EntitySet_DefaultEcs-Threading-IParallelRunner)-set 'DefaultEcs.System.AEntitySystem<T>.AEntitySystem(DefaultEcs.EntitySet, DefaultEcs.Threading.IParallelRunner).set') is null. diff --git a/documentation/api/DefaultEcs-System-AEntitySystem-T--AEntitySystem(DefaultEcs-World_DefaultEcs-System-SystemRunner-T-).md b/documentation/api/DefaultEcs-System-AEntitySystem-T--AEntitySystem(DefaultEcs-World_DefaultEcs-Threading-IParallelRunner).md similarity index 57% rename from documentation/api/DefaultEcs-System-AEntitySystem-T--AEntitySystem(DefaultEcs-World_DefaultEcs-System-SystemRunner-T-).md rename to documentation/api/DefaultEcs-System-AEntitySystem-T--AEntitySystem(DefaultEcs-World_DefaultEcs-Threading-IParallelRunner).md index f15b2de6..2bfb381b 100644 --- a/documentation/api/DefaultEcs-System-AEntitySystem-T--AEntitySystem(DefaultEcs-World_DefaultEcs-System-SystemRunner-T-).md +++ b/documentation/api/DefaultEcs-System-AEntitySystem-T--AEntitySystem(DefaultEcs-World_DefaultEcs-Threading-IParallelRunner).md @@ -1,20 +1,20 @@ #### [DefaultEcs](./index.md 'index') ### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[AEntitySystem<T>](./DefaultEcs-System-AEntitySystem-T-.md 'DefaultEcs.System.AEntitySystem<T>') -## AEntitySystem(DefaultEcs.World, DefaultEcs.System.SystemRunner<T>) Constructor +## AEntitySystem(DefaultEcs.World, DefaultEcs.Threading.IParallelRunner) Constructor Initialise a new instance of the [AEntitySystem<T>](./DefaultEcs-System-AEntitySystem-T-.md 'DefaultEcs.System.AEntitySystem<T>') class with the given [World](./DefaultEcs-World.md 'DefaultEcs.World'). To create the inner [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet'), [WithAttribute](./DefaultEcs-System-WithAttribute.md 'DefaultEcs.System.WithAttribute') and [WithoutAttribute](./DefaultEcs-System-WithoutAttribute.md 'DefaultEcs.System.WithoutAttribute') attributes will be used. ```C# -protected AEntitySystem(DefaultEcs.World world, DefaultEcs.System.SystemRunner runner); +protected AEntitySystem(DefaultEcs.World world, DefaultEcs.Threading.IParallelRunner runner); ``` #### Parameters - + `world` [World](./DefaultEcs-World.md 'DefaultEcs.World') The [World](./DefaultEcs-World.md 'DefaultEcs.World') from which to get the [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') instances to process the update. - -`runner` [DefaultEcs.System.SystemRunner<](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>')[T](./DefaultEcs-System-AEntitySystem-T-.md#DefaultEcs-System-AEntitySystem-T--T 'DefaultEcs.System.AEntitySystem<T>.T')[>](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>') -The [SystemRunner<T>](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>') used to process the update in parallel if not null. + +`runner` [IParallelRunner](./DefaultEcs-Threading-IParallelRunner.md 'DefaultEcs.Threading.IParallelRunner') +The [IParallelRunner](./DefaultEcs-Threading-IParallelRunner.md 'DefaultEcs.Threading.IParallelRunner') used to process the update in parallel if not null. #### Exceptions [System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') -[world](#DefaultEcs-System-AEntitySystem-T--AEntitySystem(DefaultEcs-World_DefaultEcs-System-SystemRunner-T-)-world 'DefaultEcs.System.AEntitySystem<T>.AEntitySystem(DefaultEcs.World, DefaultEcs.System.SystemRunner<T>).world') is null. +[world](#DefaultEcs-System-AEntitySystem-T--AEntitySystem(DefaultEcs-World_DefaultEcs-Threading-IParallelRunner)-world 'DefaultEcs.System.AEntitySystem<T>.AEntitySystem(DefaultEcs.World, DefaultEcs.Threading.IParallelRunner).world') is null. diff --git a/documentation/api/DefaultEcs-System-AEntitySystem-T--Dispose().md b/documentation/api/DefaultEcs-System-AEntitySystem-T--Dispose().md index 9bc685d3..febc0a76 100644 --- a/documentation/api/DefaultEcs-System-AEntitySystem-T--Dispose().md +++ b/documentation/api/DefaultEcs-System-AEntitySystem-T--Dispose().md @@ -3,5 +3,5 @@ ## AEntitySystem<T>.Dispose() Method Disposes of the inner [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet') instance. ```C# -public override void Dispose(); +public virtual void Dispose(); ``` diff --git a/documentation/api/DefaultEcs-System-AEntitySystem-T--IsEnabled.md b/documentation/api/DefaultEcs-System-AEntitySystem-T--IsEnabled.md index a24fa1fe..46e2c9b4 100644 --- a/documentation/api/DefaultEcs-System-AEntitySystem-T--IsEnabled.md +++ b/documentation/api/DefaultEcs-System-AEntitySystem-T--IsEnabled.md @@ -2,9 +2,8 @@ ### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[AEntitySystem<T>](./DefaultEcs-System-AEntitySystem-T-.md 'DefaultEcs.System.AEntitySystem<T>') ## AEntitySystem<T>.IsEnabled Property Gets or sets whether the current [AEntitySystem<T>](./DefaultEcs-System-AEntitySystem-T-.md 'DefaultEcs.System.AEntitySystem<T>') instance should update or not. -Will return false is there is no [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') to update. ```C# -public sealed override bool IsEnabled { get; set; } +public bool IsEnabled { get; set; } ``` #### Returns [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') diff --git a/documentation/api/DefaultEcs-System-AEntitySystem-T--PostUpdate(T).md b/documentation/api/DefaultEcs-System-AEntitySystem-T--PostUpdate(T).md index 9809cda8..8373fd90 100644 --- a/documentation/api/DefaultEcs-System-AEntitySystem-T--PostUpdate(T).md +++ b/documentation/api/DefaultEcs-System-AEntitySystem-T--PostUpdate(T).md @@ -3,7 +3,7 @@ ## AEntitySystem<T>.PostUpdate(T) Method Performs a post-update treatment. ```C# -protected override void PostUpdate(T state); +protected virtual void PostUpdate(T state); ``` #### Parameters diff --git a/documentation/api/DefaultEcs-System-AEntitySystem-T--PreUpdate(T).md b/documentation/api/DefaultEcs-System-AEntitySystem-T--PreUpdate(T).md new file mode 100644 index 00000000..533cbe84 --- /dev/null +++ b/documentation/api/DefaultEcs-System-AEntitySystem-T--PreUpdate(T).md @@ -0,0 +1,12 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[AEntitySystem<T>](./DefaultEcs-System-AEntitySystem-T-.md 'DefaultEcs.System.AEntitySystem<T>') +## AEntitySystem<T>.PreUpdate(T) Method +Performs a pre-update treatment. +```C# +protected virtual void PreUpdate(T state); +``` +#### Parameters + +`state` [T](./DefaultEcs-System-AEntitySystem-T-.md#DefaultEcs-System-AEntitySystem-T--T 'DefaultEcs.System.AEntitySystem<T>.T') +The state to use. + diff --git a/documentation/api/DefaultEcs-System-AEntitySystem-T--Update(T).md b/documentation/api/DefaultEcs-System-AEntitySystem-T--Update(T).md new file mode 100644 index 00000000..0e7e81f8 --- /dev/null +++ b/documentation/api/DefaultEcs-System-AEntitySystem-T--Update(T).md @@ -0,0 +1,13 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[AEntitySystem<T>](./DefaultEcs-System-AEntitySystem-T-.md 'DefaultEcs.System.AEntitySystem<T>') +## AEntitySystem<T>.Update(T) Method +Updates the system once. +Does nothing if [IsEnabled](./DefaultEcs-System-AEntitySystem-T--IsEnabled.md 'DefaultEcs.System.AEntitySystem<T>.IsEnabled') is false or if the inner [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet') is empty. +```C# +public void Update(T state); +``` +#### Parameters + +`state` [T](./DefaultEcs-System-AEntitySystem-T-.md#DefaultEcs-System-AEntitySystem-T--T 'DefaultEcs.System.AEntitySystem<T>.T') +The state to use. + diff --git a/documentation/api/DefaultEcs-System-AEntitySystem-T-.md b/documentation/api/DefaultEcs-System-AEntitySystem-T-.md index 445c726e..1a1c88ba 100644 --- a/documentation/api/DefaultEcs-System-AEntitySystem-T-.md +++ b/documentation/api/DefaultEcs-System-AEntitySystem-T-.md @@ -3,9 +3,13 @@ ## AEntitySystem<T> Class Represents a base class to process updates on a given [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet') instance. ```C# -public abstract class AEntitySystem : ASystem +public abstract class AEntitySystem : +ISystem, +IDisposable ``` -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') > [DefaultEcs.System.ASystem<](./DefaultEcs-System-ASystem-T-.md 'DefaultEcs.System.ASystem<T>')[T](#DefaultEcs-System-AEntitySystem-T--T 'DefaultEcs.System.AEntitySystem<T>.T')[>](./DefaultEcs-System-ASystem-T-.md 'DefaultEcs.System.ASystem<T>') > [AEntitySystem<T>](./DefaultEcs-System-AEntitySystem-T-.md 'DefaultEcs.System.AEntitySystem<T>') +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') > [AEntitySystem<T>](./DefaultEcs-System-AEntitySystem-T-.md 'DefaultEcs.System.AEntitySystem<T>') + +Implements [DefaultEcs.System.ISystem<](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>')[T](#DefaultEcs-System-AEntitySystem-T--T 'DefaultEcs.System.AEntitySystem<T>.T')[>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>'), [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable 'System.IDisposable') #### Type parameters `T` @@ -13,14 +17,16 @@ The type of the object used as state to update the system. ### Constructors - [AEntitySystem(DefaultEcs.EntitySet)](./DefaultEcs-System-AEntitySystem-T--AEntitySystem(DefaultEcs-EntitySet).md 'DefaultEcs.System.AEntitySystem<T>.AEntitySystem(DefaultEcs.EntitySet)') -- [AEntitySystem(DefaultEcs.EntitySet, DefaultEcs.System.SystemRunner<T>)](./DefaultEcs-System-AEntitySystem-T--AEntitySystem(DefaultEcs-EntitySet_DefaultEcs-System-SystemRunner-T-).md 'DefaultEcs.System.AEntitySystem<T>.AEntitySystem(DefaultEcs.EntitySet, DefaultEcs.System.SystemRunner<T>)') +- [AEntitySystem(DefaultEcs.EntitySet, DefaultEcs.Threading.IParallelRunner)](./DefaultEcs-System-AEntitySystem-T--AEntitySystem(DefaultEcs-EntitySet_DefaultEcs-Threading-IParallelRunner).md 'DefaultEcs.System.AEntitySystem<T>.AEntitySystem(DefaultEcs.EntitySet, DefaultEcs.Threading.IParallelRunner)') - [AEntitySystem(DefaultEcs.World)](./DefaultEcs-System-AEntitySystem-T--AEntitySystem(DefaultEcs-World).md 'DefaultEcs.System.AEntitySystem<T>.AEntitySystem(DefaultEcs.World)') -- [AEntitySystem(DefaultEcs.World, DefaultEcs.System.SystemRunner<T>)](./DefaultEcs-System-AEntitySystem-T--AEntitySystem(DefaultEcs-World_DefaultEcs-System-SystemRunner-T-).md 'DefaultEcs.System.AEntitySystem<T>.AEntitySystem(DefaultEcs.World, DefaultEcs.System.SystemRunner<T>)') +- [AEntitySystem(DefaultEcs.World, DefaultEcs.Threading.IParallelRunner)](./DefaultEcs-System-AEntitySystem-T--AEntitySystem(DefaultEcs-World_DefaultEcs-Threading-IParallelRunner).md 'DefaultEcs.System.AEntitySystem<T>.AEntitySystem(DefaultEcs.World, DefaultEcs.Threading.IParallelRunner)') ### Properties - [IsEnabled](./DefaultEcs-System-AEntitySystem-T--IsEnabled.md 'DefaultEcs.System.AEntitySystem<T>.IsEnabled') ### Methods - [Dispose()](./DefaultEcs-System-AEntitySystem-T--Dispose().md 'DefaultEcs.System.AEntitySystem<T>.Dispose()') - [PostUpdate(T)](./DefaultEcs-System-AEntitySystem-T--PostUpdate(T).md 'DefaultEcs.System.AEntitySystem<T>.PostUpdate(T)') +- [PreUpdate(T)](./DefaultEcs-System-AEntitySystem-T--PreUpdate(T).md 'DefaultEcs.System.AEntitySystem<T>.PreUpdate(T)') +- [Update(T)](./DefaultEcs-System-AEntitySystem-T--Update(T).md 'DefaultEcs.System.AEntitySystem<T>.Update(T)') - [Update(T, DefaultEcs.Entity)](./DefaultEcs-System-AEntitySystem-T--Update(T_DefaultEcs-Entity).md 'DefaultEcs.System.AEntitySystem<T>.Update(T, DefaultEcs.Entity)') - [Update(T, System.ReadOnlySpan<DefaultEcs.Entity>)](./DefaultEcs-System-AEntitySystem-T--Update(T_System-ReadOnlySpan-DefaultEcs-Entity-).md 'DefaultEcs.System.AEntitySystem<T>.Update(T, System.ReadOnlySpan<DefaultEcs.Entity>)') ### Events diff --git a/documentation/api/DefaultEcs-System-ASystem-T--ASystem(DefaultEcs-System-SystemRunner-T-).md b/documentation/api/DefaultEcs-System-ASystem-T--ASystem(DefaultEcs-System-SystemRunner-T-).md deleted file mode 100644 index 3a1a3518..00000000 --- a/documentation/api/DefaultEcs-System-ASystem-T--ASystem(DefaultEcs-System-SystemRunner-T-).md +++ /dev/null @@ -1,12 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[ASystem<T>](./DefaultEcs-System-ASystem-T-.md 'DefaultEcs.System.ASystem<T>') -## ASystem(DefaultEcs.System.SystemRunner<T>) Constructor -Initialise a new instance of the [ASystem<T>](./DefaultEcs-System-ASystem-T-.md 'DefaultEcs.System.ASystem<T>') class with the given [SystemRunner<T>](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>'). -```C# -protected ASystem(DefaultEcs.System.SystemRunner runner); -``` -#### Parameters - -`runner` [DefaultEcs.System.SystemRunner<](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>')[T](./DefaultEcs-System-ASystem-T-.md#DefaultEcs-System-ASystem-T--T 'DefaultEcs.System.ASystem<T>.T')[>](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>') -The [SystemRunner<T>](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>') used to process the update in parallel if not null. - diff --git a/documentation/api/DefaultEcs-System-ASystem-T--Dispose().md b/documentation/api/DefaultEcs-System-ASystem-T--Dispose().md deleted file mode 100644 index 457cdb2c..00000000 --- a/documentation/api/DefaultEcs-System-ASystem-T--Dispose().md +++ /dev/null @@ -1,7 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[ASystem<T>](./DefaultEcs-System-ASystem-T-.md 'DefaultEcs.System.ASystem<T>') -## ASystem<T>.Dispose() Method -Does nothing. -```C# -public abstract void Dispose(); -``` diff --git a/documentation/api/DefaultEcs-System-ASystem-T--IsEnabled.md b/documentation/api/DefaultEcs-System-ASystem-T--IsEnabled.md deleted file mode 100644 index 4ec260e1..00000000 --- a/documentation/api/DefaultEcs-System-ASystem-T--IsEnabled.md +++ /dev/null @@ -1,9 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[ASystem<T>](./DefaultEcs-System-ASystem-T-.md 'DefaultEcs.System.ASystem<T>') -## ASystem<T>.IsEnabled Property -Gets or sets whether the current [ASystem<T>](./DefaultEcs-System-ASystem-T-.md 'DefaultEcs.System.ASystem<T>') instance should update or not. -```C# -public virtual bool IsEnabled { get; set; } -``` -#### Returns -[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') diff --git a/documentation/api/DefaultEcs-System-ASystem-T--PostUpdate(T).md b/documentation/api/DefaultEcs-System-ASystem-T--PostUpdate(T).md deleted file mode 100644 index da0eab0d..00000000 --- a/documentation/api/DefaultEcs-System-ASystem-T--PostUpdate(T).md +++ /dev/null @@ -1,12 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[ASystem<T>](./DefaultEcs-System-ASystem-T-.md 'DefaultEcs.System.ASystem<T>') -## ASystem<T>.PostUpdate(T) Method -Performs a post-update treatment. -```C# -protected virtual void PostUpdate(T state); -``` -#### Parameters - -`state` [T](./DefaultEcs-System-ASystem-T-.md#DefaultEcs-System-ASystem-T--T 'DefaultEcs.System.ASystem<T>.T') -The state to use. - diff --git a/documentation/api/DefaultEcs-System-ASystem-T--PreUpdate(T).md b/documentation/api/DefaultEcs-System-ASystem-T--PreUpdate(T).md deleted file mode 100644 index f33dfa9a..00000000 --- a/documentation/api/DefaultEcs-System-ASystem-T--PreUpdate(T).md +++ /dev/null @@ -1,12 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[ASystem<T>](./DefaultEcs-System-ASystem-T-.md 'DefaultEcs.System.ASystem<T>') -## ASystem<T>.PreUpdate(T) Method -Performs a pre-update treatment. -```C# -protected virtual void PreUpdate(T state); -``` -#### Parameters - -`state` [T](./DefaultEcs-System-ASystem-T-.md#DefaultEcs-System-ASystem-T--T 'DefaultEcs.System.ASystem<T>.T') -The state to use. - diff --git a/documentation/api/DefaultEcs-System-ASystem-T--Update(T).md b/documentation/api/DefaultEcs-System-ASystem-T--Update(T).md deleted file mode 100644 index 2a6d1d73..00000000 --- a/documentation/api/DefaultEcs-System-ASystem-T--Update(T).md +++ /dev/null @@ -1,12 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[ASystem<T>](./DefaultEcs-System-ASystem-T-.md 'DefaultEcs.System.ASystem<T>') -## ASystem<T>.Update(T) Method -Updates the system once. -```C# -public void Update(T state); -``` -#### Parameters - -`state` [T](./DefaultEcs-System-ASystem-T-.md#DefaultEcs-System-ASystem-T--T 'DefaultEcs.System.ASystem<T>.T') -The state to use. - diff --git a/documentation/api/DefaultEcs-System-ASystem-T-.md b/documentation/api/DefaultEcs-System-ASystem-T-.md deleted file mode 100644 index 32f43c3f..00000000 --- a/documentation/api/DefaultEcs-System-ASystem-T-.md +++ /dev/null @@ -1,26 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System') -## ASystem<T> Class -Represents a base class to process updates, supporting a [SystemRunner<T>](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>'). Do not inherit from this class directly. -```C# -public abstract class ASystem : -ISystem, -IDisposable -``` -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') > [ASystem<T>](./DefaultEcs-System-ASystem-T-.md 'DefaultEcs.System.ASystem<T>') - -Implements [DefaultEcs.System.ISystem<](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>')[T](#DefaultEcs-System-ASystem-T--T 'DefaultEcs.System.ASystem<T>.T')[>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>'), [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable 'System.IDisposable') -#### Type parameters - -`T` -The type of the object used as state to update the system. - -### Constructors -- [ASystem(DefaultEcs.System.SystemRunner<T>)](./DefaultEcs-System-ASystem-T--ASystem(DefaultEcs-System-SystemRunner-T-).md 'DefaultEcs.System.ASystem<T>.ASystem(DefaultEcs.System.SystemRunner<T>)') -### Properties -- [IsEnabled](./DefaultEcs-System-ASystem-T--IsEnabled.md 'DefaultEcs.System.ASystem<T>.IsEnabled') -### Methods -- [Dispose()](./DefaultEcs-System-ASystem-T--Dispose().md 'DefaultEcs.System.ASystem<T>.Dispose()') -- [PostUpdate(T)](./DefaultEcs-System-ASystem-T--PostUpdate(T).md 'DefaultEcs.System.ASystem<T>.PostUpdate(T)') -- [PreUpdate(T)](./DefaultEcs-System-ASystem-T--PreUpdate(T).md 'DefaultEcs.System.ASystem<T>.PreUpdate(T)') -- [Update(T)](./DefaultEcs-System-ASystem-T--Update(T).md 'DefaultEcs.System.ASystem<T>.Update(T)') diff --git a/documentation/api/DefaultEcs-System-DisabledAttribute.md b/documentation/api/DefaultEcs-System-DisabledAttribute.md new file mode 100644 index 00000000..21c9a15a --- /dev/null +++ b/documentation/api/DefaultEcs-System-DisabledAttribute.md @@ -0,0 +1,8 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System') +## DisabledAttribute Class +Makes so when building the inner [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet') of [AEntitySystem<T>](./DefaultEcs-System-AEntitySystem-T-.md 'DefaultEcs.System.AEntitySystem<T>') when giving a [World](./DefaultEcs-World.md 'DefaultEcs.World') instance, it will only contain disabled entities. +```C# +public sealed class DisabledAttribute : Attribute +``` +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') > [System.Attribute](https://docs.microsoft.com/en-us/dotnet/api/System.Attribute 'System.Attribute') > [DisabledAttribute](./DefaultEcs-System-DisabledAttribute.md 'DefaultEcs.System.DisabledAttribute') diff --git a/documentation/api/DefaultEcs-System-ISystem-T--Update(T).md b/documentation/api/DefaultEcs-System-ISystem-T--Update(T).md index 33e7d33b..7f0c791a 100644 --- a/documentation/api/DefaultEcs-System-ISystem-T--Update(T).md +++ b/documentation/api/DefaultEcs-System-ISystem-T--Update(T).md @@ -2,6 +2,7 @@ ### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[ISystem<T>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>') ## ISystem<T>.Update(T) Method Updates the system once. +Does nothing if [IsEnabled](./DefaultEcs-System-ISystem-T--IsEnabled.md 'DefaultEcs.System.ISystem<T>.IsEnabled') is false. ```C# void Update(T state); ``` diff --git a/documentation/api/DefaultEcs-System-ParallelSystem-T--Dispose().md b/documentation/api/DefaultEcs-System-ParallelSystem-T--Dispose().md index 7e6887cb..0aad75b8 100644 --- a/documentation/api/DefaultEcs-System-ParallelSystem-T--Dispose().md +++ b/documentation/api/DefaultEcs-System-ParallelSystem-T--Dispose().md @@ -3,5 +3,5 @@ ## ParallelSystem<T>.Dispose() Method Disposes all the inner [ISystem<T>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>') instances. ```C# -public override void Dispose(); +public void Dispose(); ``` diff --git a/documentation/api/DefaultEcs-System-ParallelSystem-T--IsEnabled.md b/documentation/api/DefaultEcs-System-ParallelSystem-T--IsEnabled.md new file mode 100644 index 00000000..3fcead71 --- /dev/null +++ b/documentation/api/DefaultEcs-System-ParallelSystem-T--IsEnabled.md @@ -0,0 +1,9 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[ParallelSystem<T>](./DefaultEcs-System-ParallelSystem-T-.md 'DefaultEcs.System.ParallelSystem<T>') +## ParallelSystem<T>.IsEnabled Property +Gets or sets whether the current [ParallelSystem<T>](./DefaultEcs-System-ParallelSystem-T-.md 'DefaultEcs.System.ParallelSystem<T>') instance should update or not. +```C# +public bool IsEnabled { get; set; } +``` +#### Returns +[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean') diff --git a/documentation/api/DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-ISystem-T-_DefaultEcs-System-SystemRunner-T-_DefaultEcs-System-ISystem-T---).md b/documentation/api/DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-ISystem-T-_DefaultEcs-System-SystemRunner-T-_DefaultEcs-System-ISystem-T---).md deleted file mode 100644 index a009bd35..00000000 --- a/documentation/api/DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-ISystem-T-_DefaultEcs-System-SystemRunner-T-_DefaultEcs-System-ISystem-T---).md +++ /dev/null @@ -1,20 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[ParallelSystem<T>](./DefaultEcs-System-ParallelSystem-T-.md 'DefaultEcs.System.ParallelSystem<T>') -## ParallelSystem(DefaultEcs.System.ISystem<T>, DefaultEcs.System.SystemRunner<T>, DefaultEcs.System.ISystem<T>[]) Constructor -Initialises a new instance of the [ParallelSystem<T>](./DefaultEcs-System-ParallelSystem-T-.md 'DefaultEcs.System.ParallelSystem<T>') class. -```C# -public ParallelSystem(DefaultEcs.System.ISystem mainSystem, DefaultEcs.System.SystemRunner runner, params DefaultEcs.System.ISystem[] systems); -``` -#### Parameters - -`mainSystem` [DefaultEcs.System.ISystem<](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>')[T](./DefaultEcs-System-ParallelSystem-T-.md#DefaultEcs-System-ParallelSystem-T--T 'DefaultEcs.System.ParallelSystem<T>.T')[>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>') -The [ISystem<T>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>') instance to be updated on the calling thread. - - -`runner` [DefaultEcs.System.SystemRunner<](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>')[T](./DefaultEcs-System-ParallelSystem-T-.md#DefaultEcs-System-ParallelSystem-T--T 'DefaultEcs.System.ParallelSystem<T>.T')[>](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>') -The [SystemRunner<T>](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>') used to process the update in parallel if not null. - - -`systems` [DefaultEcs.System.ISystem<](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>')[T](./DefaultEcs-System-ParallelSystem-T-.md#DefaultEcs-System-ParallelSystem-T--T 'DefaultEcs.System.ParallelSystem<T>.T')[>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') -The [ISystem<T>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>') instances. - diff --git a/documentation/api/DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-ISystem-T-_DefaultEcs-System-SystemRunner-T-_System-Collections-Generic-IEnumerable-DefaultEcs-System-ISystem-T--).md b/documentation/api/DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-ISystem-T-_DefaultEcs-System-SystemRunner-T-_System-Collections-Generic-IEnumerable-DefaultEcs-System-ISystem-T--).md deleted file mode 100644 index c27d1810..00000000 --- a/documentation/api/DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-ISystem-T-_DefaultEcs-System-SystemRunner-T-_System-Collections-Generic-IEnumerable-DefaultEcs-System-ISystem-T--).md +++ /dev/null @@ -1,20 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[ParallelSystem<T>](./DefaultEcs-System-ParallelSystem-T-.md 'DefaultEcs.System.ParallelSystem<T>') -## ParallelSystem(DefaultEcs.System.ISystem<T>, DefaultEcs.System.SystemRunner<T>, System.Collections.Generic.IEnumerable<DefaultEcs.System.ISystem<T>>) Constructor -Initialises a new instance of the [ParallelSystem<T>](./DefaultEcs-System-ParallelSystem-T-.md 'DefaultEcs.System.ParallelSystem<T>') class. -```C# -public ParallelSystem(DefaultEcs.System.ISystem mainSystem, DefaultEcs.System.SystemRunner runner, System.Collections.Generic.IEnumerable> systems); -``` -#### Parameters - -`mainSystem` [DefaultEcs.System.ISystem<](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>')[T](./DefaultEcs-System-ParallelSystem-T-.md#DefaultEcs-System-ParallelSystem-T--T 'DefaultEcs.System.ParallelSystem<T>.T')[>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>') -The [ISystem<T>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>') instance to be updated on the calling thread. - - -`runner` [DefaultEcs.System.SystemRunner<](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>')[T](./DefaultEcs-System-ParallelSystem-T-.md#DefaultEcs-System-ParallelSystem-T--T 'DefaultEcs.System.ParallelSystem<T>.T')[>](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>') -The [SystemRunner<T>](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>') used to process the update in parallel if not null. - - -`systems` [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[DefaultEcs.System.ISystem<](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>')[T](./DefaultEcs-System-ParallelSystem-T-.md#DefaultEcs-System-ParallelSystem-T--T 'DefaultEcs.System.ParallelSystem<T>.T')[>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') -The [ISystem<T>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>') instances. - diff --git a/documentation/api/DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-ISystem-T-_DefaultEcs-Threading-IParallelRunner_DefaultEcs-System-ISystem-T---).md b/documentation/api/DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-ISystem-T-_DefaultEcs-Threading-IParallelRunner_DefaultEcs-System-ISystem-T---).md new file mode 100644 index 00000000..3fd3a9f9 --- /dev/null +++ b/documentation/api/DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-ISystem-T-_DefaultEcs-Threading-IParallelRunner_DefaultEcs-System-ISystem-T---).md @@ -0,0 +1,25 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[ParallelSystem<T>](./DefaultEcs-System-ParallelSystem-T-.md 'DefaultEcs.System.ParallelSystem<T>') +## ParallelSystem(DefaultEcs.System.ISystem<T>, DefaultEcs.Threading.IParallelRunner, DefaultEcs.System.ISystem<T>[]) Constructor +Initialises a new instance of the [ParallelSystem<T>](./DefaultEcs-System-ParallelSystem-T-.md 'DefaultEcs.System.ParallelSystem<T>') class. +```C# +public ParallelSystem(DefaultEcs.System.ISystem mainSystem, DefaultEcs.Threading.IParallelRunner runner, params DefaultEcs.System.ISystem[] systems); +``` +#### Parameters + +`mainSystem` [DefaultEcs.System.ISystem<](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>')[T](./DefaultEcs-System-ParallelSystem-T-.md#DefaultEcs-System-ParallelSystem-T--T 'DefaultEcs.System.ParallelSystem<T>.T')[>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>') +The [ISystem<T>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>') instance to be updated on the calling thread. + + +`runner` [IParallelRunner](./DefaultEcs-Threading-IParallelRunner.md 'DefaultEcs.Threading.IParallelRunner') +The [IParallelRunner](./DefaultEcs-Threading-IParallelRunner.md 'DefaultEcs.Threading.IParallelRunner') used to process the update in parallel if not null. + + +`systems` [DefaultEcs.System.ISystem<](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>')[T](./DefaultEcs-System-ParallelSystem-T-.md#DefaultEcs-System-ParallelSystem-T--T 'DefaultEcs.System.ParallelSystem<T>.T')[>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') +The [ISystem<T>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>') instances. + +#### Exceptions +[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') +[runner](#DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-ISystem-T-_DefaultEcs-Threading-IParallelRunner_DefaultEcs-System-ISystem-T---)-runner 'DefaultEcs.System.ParallelSystem<T>.ParallelSystem(DefaultEcs.System.ISystem<T>, DefaultEcs.Threading.IParallelRunner, DefaultEcs.System.ISystem<T>[]).runner') is null. +[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') +[systems](#DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-ISystem-T-_DefaultEcs-Threading-IParallelRunner_DefaultEcs-System-ISystem-T---)-systems 'DefaultEcs.System.ParallelSystem<T>.ParallelSystem(DefaultEcs.System.ISystem<T>, DefaultEcs.Threading.IParallelRunner, DefaultEcs.System.ISystem<T>[]).systems') is null. diff --git a/documentation/api/DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-ISystem-T-_DefaultEcs-Threading-IParallelRunner_System-Collections-Generic-IEnumerable-DefaultEcs-System-ISystem-T--).md b/documentation/api/DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-ISystem-T-_DefaultEcs-Threading-IParallelRunner_System-Collections-Generic-IEnumerable-DefaultEcs-System-ISystem-T--).md new file mode 100644 index 00000000..b6d0883a --- /dev/null +++ b/documentation/api/DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-ISystem-T-_DefaultEcs-Threading-IParallelRunner_System-Collections-Generic-IEnumerable-DefaultEcs-System-ISystem-T--).md @@ -0,0 +1,25 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[ParallelSystem<T>](./DefaultEcs-System-ParallelSystem-T-.md 'DefaultEcs.System.ParallelSystem<T>') +## ParallelSystem(DefaultEcs.System.ISystem<T>, DefaultEcs.Threading.IParallelRunner, System.Collections.Generic.IEnumerable<DefaultEcs.System.ISystem<T>>) Constructor +Initialises a new instance of the [ParallelSystem<T>](./DefaultEcs-System-ParallelSystem-T-.md 'DefaultEcs.System.ParallelSystem<T>') class. +```C# +public ParallelSystem(DefaultEcs.System.ISystem mainSystem, DefaultEcs.Threading.IParallelRunner runner, System.Collections.Generic.IEnumerable> systems); +``` +#### Parameters + +`mainSystem` [DefaultEcs.System.ISystem<](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>')[T](./DefaultEcs-System-ParallelSystem-T-.md#DefaultEcs-System-ParallelSystem-T--T 'DefaultEcs.System.ParallelSystem<T>.T')[>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>') +The [ISystem<T>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>') instance to be updated on the calling thread. + + +`runner` [IParallelRunner](./DefaultEcs-Threading-IParallelRunner.md 'DefaultEcs.Threading.IParallelRunner') +The [IParallelRunner](./DefaultEcs-Threading-IParallelRunner.md 'DefaultEcs.Threading.IParallelRunner') used to process the update in parallel if not null. + + +`systems` [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[DefaultEcs.System.ISystem<](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>')[T](./DefaultEcs-System-ParallelSystem-T-.md#DefaultEcs-System-ParallelSystem-T--T 'DefaultEcs.System.ParallelSystem<T>.T')[>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') +The [ISystem<T>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>') instances. + +#### Exceptions +[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') +[runner](#DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-ISystem-T-_DefaultEcs-Threading-IParallelRunner_System-Collections-Generic-IEnumerable-DefaultEcs-System-ISystem-T--)-runner 'DefaultEcs.System.ParallelSystem<T>.ParallelSystem(DefaultEcs.System.ISystem<T>, DefaultEcs.Threading.IParallelRunner, System.Collections.Generic.IEnumerable<DefaultEcs.System.ISystem<T>>).runner') is null. +[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') +[systems](#DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-ISystem-T-_DefaultEcs-Threading-IParallelRunner_System-Collections-Generic-IEnumerable-DefaultEcs-System-ISystem-T--)-systems 'DefaultEcs.System.ParallelSystem<T>.ParallelSystem(DefaultEcs.System.ISystem<T>, DefaultEcs.Threading.IParallelRunner, System.Collections.Generic.IEnumerable<DefaultEcs.System.ISystem<T>>).systems') is null. diff --git a/documentation/api/DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-SystemRunner-T-_DefaultEcs-System-ISystem-T---).md b/documentation/api/DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-SystemRunner-T-_DefaultEcs-System-ISystem-T---).md deleted file mode 100644 index 09f36b74..00000000 --- a/documentation/api/DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-SystemRunner-T-_DefaultEcs-System-ISystem-T---).md +++ /dev/null @@ -1,16 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[ParallelSystem<T>](./DefaultEcs-System-ParallelSystem-T-.md 'DefaultEcs.System.ParallelSystem<T>') -## ParallelSystem(DefaultEcs.System.SystemRunner<T>, DefaultEcs.System.ISystem<T>[]) Constructor -Initialises a new instance of the [ParallelSystem<T>](./DefaultEcs-System-ParallelSystem-T-.md 'DefaultEcs.System.ParallelSystem<T>') class. -```C# -public ParallelSystem(DefaultEcs.System.SystemRunner runner, params DefaultEcs.System.ISystem[] systems); -``` -#### Parameters - -`runner` [DefaultEcs.System.SystemRunner<](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>')[T](./DefaultEcs-System-ParallelSystem-T-.md#DefaultEcs-System-ParallelSystem-T--T 'DefaultEcs.System.ParallelSystem<T>.T')[>](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>') -The [SystemRunner<T>](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>') used to process the update in parallel if not null. - - -`systems` [DefaultEcs.System.ISystem<](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>')[T](./DefaultEcs-System-ParallelSystem-T-.md#DefaultEcs-System-ParallelSystem-T--T 'DefaultEcs.System.ParallelSystem<T>.T')[>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') -The [ISystem<T>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>') instances. - diff --git a/documentation/api/DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-SystemRunner-T-_System-Collections-Generic-IEnumerable-DefaultEcs-System-ISystem-T--).md b/documentation/api/DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-SystemRunner-T-_System-Collections-Generic-IEnumerable-DefaultEcs-System-ISystem-T--).md deleted file mode 100644 index 7d58d2e7..00000000 --- a/documentation/api/DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-SystemRunner-T-_System-Collections-Generic-IEnumerable-DefaultEcs-System-ISystem-T--).md +++ /dev/null @@ -1,16 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[ParallelSystem<T>](./DefaultEcs-System-ParallelSystem-T-.md 'DefaultEcs.System.ParallelSystem<T>') -## ParallelSystem(DefaultEcs.System.SystemRunner<T>, System.Collections.Generic.IEnumerable<DefaultEcs.System.ISystem<T>>) Constructor -Initialises a new instance of the [ParallelSystem<T>](./DefaultEcs-System-ParallelSystem-T-.md 'DefaultEcs.System.ParallelSystem<T>') class. -```C# -public ParallelSystem(DefaultEcs.System.SystemRunner runner, System.Collections.Generic.IEnumerable> systems); -``` -#### Parameters - -`runner` [DefaultEcs.System.SystemRunner<](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>')[T](./DefaultEcs-System-ParallelSystem-T-.md#DefaultEcs-System-ParallelSystem-T--T 'DefaultEcs.System.ParallelSystem<T>.T')[>](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>') -The [SystemRunner<T>](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>') used to process the update in parallel if not null. - - -`systems` [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[DefaultEcs.System.ISystem<](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>')[T](./DefaultEcs-System-ParallelSystem-T-.md#DefaultEcs-System-ParallelSystem-T--T 'DefaultEcs.System.ParallelSystem<T>.T')[>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') -The [ISystem<T>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>') instances. - diff --git a/documentation/api/DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-Threading-IParallelRunner_DefaultEcs-System-ISystem-T---).md b/documentation/api/DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-Threading-IParallelRunner_DefaultEcs-System-ISystem-T---).md new file mode 100644 index 00000000..b429ec55 --- /dev/null +++ b/documentation/api/DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-Threading-IParallelRunner_DefaultEcs-System-ISystem-T---).md @@ -0,0 +1,21 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[ParallelSystem<T>](./DefaultEcs-System-ParallelSystem-T-.md 'DefaultEcs.System.ParallelSystem<T>') +## ParallelSystem(DefaultEcs.Threading.IParallelRunner, DefaultEcs.System.ISystem<T>[]) Constructor +Initialises a new instance of the [ParallelSystem<T>](./DefaultEcs-System-ParallelSystem-T-.md 'DefaultEcs.System.ParallelSystem<T>') class. +```C# +public ParallelSystem(DefaultEcs.Threading.IParallelRunner runner, params DefaultEcs.System.ISystem[] systems); +``` +#### Parameters + +`runner` [IParallelRunner](./DefaultEcs-Threading-IParallelRunner.md 'DefaultEcs.Threading.IParallelRunner') +The [IParallelRunner](./DefaultEcs-Threading-IParallelRunner.md 'DefaultEcs.Threading.IParallelRunner') used to process the update in parallel if not null. + + +`systems` [DefaultEcs.System.ISystem<](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>')[T](./DefaultEcs-System-ParallelSystem-T-.md#DefaultEcs-System-ParallelSystem-T--T 'DefaultEcs.System.ParallelSystem<T>.T')[>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') +The [ISystem<T>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>') instances. + +#### Exceptions +[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') +[runner](#DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-Threading-IParallelRunner_DefaultEcs-System-ISystem-T---)-runner 'DefaultEcs.System.ParallelSystem<T>.ParallelSystem(DefaultEcs.Threading.IParallelRunner, DefaultEcs.System.ISystem<T>[]).runner') is null. +[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') +[systems](#DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-Threading-IParallelRunner_DefaultEcs-System-ISystem-T---)-systems 'DefaultEcs.System.ParallelSystem<T>.ParallelSystem(DefaultEcs.Threading.IParallelRunner, DefaultEcs.System.ISystem<T>[]).systems') is null. diff --git a/documentation/api/DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-Threading-IParallelRunner_System-Collections-Generic-IEnumerable-DefaultEcs-System-ISystem-T--).md b/documentation/api/DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-Threading-IParallelRunner_System-Collections-Generic-IEnumerable-DefaultEcs-System-ISystem-T--).md new file mode 100644 index 00000000..b97df023 --- /dev/null +++ b/documentation/api/DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-Threading-IParallelRunner_System-Collections-Generic-IEnumerable-DefaultEcs-System-ISystem-T--).md @@ -0,0 +1,21 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[ParallelSystem<T>](./DefaultEcs-System-ParallelSystem-T-.md 'DefaultEcs.System.ParallelSystem<T>') +## ParallelSystem(DefaultEcs.Threading.IParallelRunner, System.Collections.Generic.IEnumerable<DefaultEcs.System.ISystem<T>>) Constructor +Initialises a new instance of the [ParallelSystem<T>](./DefaultEcs-System-ParallelSystem-T-.md 'DefaultEcs.System.ParallelSystem<T>') class. +```C# +public ParallelSystem(DefaultEcs.Threading.IParallelRunner runner, System.Collections.Generic.IEnumerable> systems); +``` +#### Parameters + +`runner` [IParallelRunner](./DefaultEcs-Threading-IParallelRunner.md 'DefaultEcs.Threading.IParallelRunner') +The [IParallelRunner](./DefaultEcs-Threading-IParallelRunner.md 'DefaultEcs.Threading.IParallelRunner') used to process the update in parallel if not null. + + +`systems` [System.Collections.Generic.IEnumerable<](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1')[DefaultEcs.System.ISystem<](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>')[T](./DefaultEcs-System-ParallelSystem-T-.md#DefaultEcs-System-ParallelSystem-T--T 'DefaultEcs.System.ParallelSystem<T>.T')[>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>')[>](https://docs.microsoft.com/en-us/dotnet/api/System.Collections.Generic.IEnumerable-1 'System.Collections.Generic.IEnumerable`1') +The [ISystem<T>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>') instances. + +#### Exceptions +[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') +[runner](#DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-Threading-IParallelRunner_System-Collections-Generic-IEnumerable-DefaultEcs-System-ISystem-T--)-runner 'DefaultEcs.System.ParallelSystem<T>.ParallelSystem(DefaultEcs.Threading.IParallelRunner, System.Collections.Generic.IEnumerable<DefaultEcs.System.ISystem<T>>).runner') is null. +[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') +[systems](#DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-Threading-IParallelRunner_System-Collections-Generic-IEnumerable-DefaultEcs-System-ISystem-T--)-systems 'DefaultEcs.System.ParallelSystem<T>.ParallelSystem(DefaultEcs.Threading.IParallelRunner, System.Collections.Generic.IEnumerable<DefaultEcs.System.ISystem<T>>).systems') is null. diff --git a/documentation/api/DefaultEcs-System-ParallelSystem-T--PreUpdate(T).md b/documentation/api/DefaultEcs-System-ParallelSystem-T--Update(T).md similarity index 67% rename from documentation/api/DefaultEcs-System-ParallelSystem-T--PreUpdate(T).md rename to documentation/api/DefaultEcs-System-ParallelSystem-T--Update(T).md index 87b6a665..bd7d414d 100644 --- a/documentation/api/DefaultEcs-System-ParallelSystem-T--PreUpdate(T).md +++ b/documentation/api/DefaultEcs-System-ParallelSystem-T--Update(T).md @@ -1,12 +1,12 @@ #### [DefaultEcs](./index.md 'index') ### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System').[ParallelSystem<T>](./DefaultEcs-System-ParallelSystem-T-.md 'DefaultEcs.System.ParallelSystem<T>') -## ParallelSystem<T>.PreUpdate(T) Method -Performs a pre-update treatment. +## ParallelSystem<T>.Update(T) Method +Updates the system once. ```C# -protected override void PreUpdate(T state); +public void Update(T state); ``` #### Parameters - + `state` [T](./DefaultEcs-System-ParallelSystem-T-.md#DefaultEcs-System-ParallelSystem-T--T 'DefaultEcs.System.ParallelSystem<T>.T') The state to use. diff --git a/documentation/api/DefaultEcs-System-ParallelSystem-T-.md b/documentation/api/DefaultEcs-System-ParallelSystem-T-.md index 2553560c..3fa7df6d 100644 --- a/documentation/api/DefaultEcs-System-ParallelSystem-T-.md +++ b/documentation/api/DefaultEcs-System-ParallelSystem-T-.md @@ -3,19 +3,25 @@ ## ParallelSystem<T> Class Represents a collection of [ISystem<T>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>') to update in parallel. ```C# -public sealed class ParallelSystem : ASystem +public sealed class ParallelSystem : +ISystem, +IDisposable ``` -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') > [DefaultEcs.System.ASystem<](./DefaultEcs-System-ASystem-T-.md 'DefaultEcs.System.ASystem<T>')[T](#DefaultEcs-System-ParallelSystem-T--T 'DefaultEcs.System.ParallelSystem<T>.T')[>](./DefaultEcs-System-ASystem-T-.md 'DefaultEcs.System.ASystem<T>') > [ParallelSystem<T>](./DefaultEcs-System-ParallelSystem-T-.md 'DefaultEcs.System.ParallelSystem<T>') +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') > [ParallelSystem<T>](./DefaultEcs-System-ParallelSystem-T-.md 'DefaultEcs.System.ParallelSystem<T>') + +Implements [DefaultEcs.System.ISystem<](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>')[T](#DefaultEcs-System-ParallelSystem-T--T 'DefaultEcs.System.ParallelSystem<T>.T')[>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>'), [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable 'System.IDisposable') #### Type parameters `T` The type of the object used as state to update the systems. ### Constructors -- [ParallelSystem(DefaultEcs.System.ISystem<T>, DefaultEcs.System.SystemRunner<T>, DefaultEcs.System.ISystem<T>[])](./DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-ISystem-T-_DefaultEcs-System-SystemRunner-T-_DefaultEcs-System-ISystem-T---).md 'DefaultEcs.System.ParallelSystem<T>.ParallelSystem(DefaultEcs.System.ISystem<T>, DefaultEcs.System.SystemRunner<T>, DefaultEcs.System.ISystem<T>[])') -- [ParallelSystem(DefaultEcs.System.ISystem<T>, DefaultEcs.System.SystemRunner<T>, System.Collections.Generic.IEnumerable<DefaultEcs.System.ISystem<T>>)](./DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-ISystem-T-_DefaultEcs-System-SystemRunner-T-_System-Collections-Generic-IEnumerable-DefaultEcs-System-ISystem-T--).md 'DefaultEcs.System.ParallelSystem<T>.ParallelSystem(DefaultEcs.System.ISystem<T>, DefaultEcs.System.SystemRunner<T>, System.Collections.Generic.IEnumerable<DefaultEcs.System.ISystem<T>>)') -- [ParallelSystem(DefaultEcs.System.SystemRunner<T>, DefaultEcs.System.ISystem<T>[])](./DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-SystemRunner-T-_DefaultEcs-System-ISystem-T---).md 'DefaultEcs.System.ParallelSystem<T>.ParallelSystem(DefaultEcs.System.SystemRunner<T>, DefaultEcs.System.ISystem<T>[])') -- [ParallelSystem(DefaultEcs.System.SystemRunner<T>, System.Collections.Generic.IEnumerable<DefaultEcs.System.ISystem<T>>)](./DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-SystemRunner-T-_System-Collections-Generic-IEnumerable-DefaultEcs-System-ISystem-T--).md 'DefaultEcs.System.ParallelSystem<T>.ParallelSystem(DefaultEcs.System.SystemRunner<T>, System.Collections.Generic.IEnumerable<DefaultEcs.System.ISystem<T>>)') +- [ParallelSystem(DefaultEcs.System.ISystem<T>, DefaultEcs.Threading.IParallelRunner, DefaultEcs.System.ISystem<T>[])](./DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-ISystem-T-_DefaultEcs-Threading-IParallelRunner_DefaultEcs-System-ISystem-T---).md 'DefaultEcs.System.ParallelSystem<T>.ParallelSystem(DefaultEcs.System.ISystem<T>, DefaultEcs.Threading.IParallelRunner, DefaultEcs.System.ISystem<T>[])') +- [ParallelSystem(DefaultEcs.System.ISystem<T>, DefaultEcs.Threading.IParallelRunner, System.Collections.Generic.IEnumerable<DefaultEcs.System.ISystem<T>>)](./DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-System-ISystem-T-_DefaultEcs-Threading-IParallelRunner_System-Collections-Generic-IEnumerable-DefaultEcs-System-ISystem-T--).md 'DefaultEcs.System.ParallelSystem<T>.ParallelSystem(DefaultEcs.System.ISystem<T>, DefaultEcs.Threading.IParallelRunner, System.Collections.Generic.IEnumerable<DefaultEcs.System.ISystem<T>>)') +- [ParallelSystem(DefaultEcs.Threading.IParallelRunner, DefaultEcs.System.ISystem<T>[])](./DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-Threading-IParallelRunner_DefaultEcs-System-ISystem-T---).md 'DefaultEcs.System.ParallelSystem<T>.ParallelSystem(DefaultEcs.Threading.IParallelRunner, DefaultEcs.System.ISystem<T>[])') +- [ParallelSystem(DefaultEcs.Threading.IParallelRunner, System.Collections.Generic.IEnumerable<DefaultEcs.System.ISystem<T>>)](./DefaultEcs-System-ParallelSystem-T--ParallelSystem(DefaultEcs-Threading-IParallelRunner_System-Collections-Generic-IEnumerable-DefaultEcs-System-ISystem-T--).md 'DefaultEcs.System.ParallelSystem<T>.ParallelSystem(DefaultEcs.Threading.IParallelRunner, System.Collections.Generic.IEnumerable<DefaultEcs.System.ISystem<T>>)') +### Properties +- [IsEnabled](./DefaultEcs-System-ParallelSystem-T--IsEnabled.md 'DefaultEcs.System.ParallelSystem<T>.IsEnabled') ### Methods - [Dispose()](./DefaultEcs-System-ParallelSystem-T--Dispose().md 'DefaultEcs.System.ParallelSystem<T>.Dispose()') -- [PreUpdate(T)](./DefaultEcs-System-ParallelSystem-T--PreUpdate(T).md 'DefaultEcs.System.ParallelSystem<T>.PreUpdate(T)') +- [Update(T)](./DefaultEcs-System-ParallelSystem-T--Update(T).md 'DefaultEcs.System.ParallelSystem<T>.Update(T)') diff --git a/documentation/api/DefaultEcs-System-SequentialSystem-T--SequentialSystem(DefaultEcs-System-ISystem-T---).md b/documentation/api/DefaultEcs-System-SequentialSystem-T--SequentialSystem(DefaultEcs-System-ISystem-T---).md index 278e806d..14205b1c 100644 --- a/documentation/api/DefaultEcs-System-SequentialSystem-T--SequentialSystem(DefaultEcs-System-ISystem-T---).md +++ b/documentation/api/DefaultEcs-System-SequentialSystem-T--SequentialSystem(DefaultEcs-System-ISystem-T---).md @@ -10,3 +10,6 @@ public SequentialSystem(params DefaultEcs.System.ISystem[] systems); `systems` [DefaultEcs.System.ISystem<](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>')[T](./DefaultEcs-System-SequentialSystem-T-.md#DefaultEcs-System-SequentialSystem-T--T 'DefaultEcs.System.SequentialSystem<T>.T')[>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array') The [ISystem<T>](./DefaultEcs-System-ISystem-T-.md 'DefaultEcs.System.ISystem<T>') instances. +#### Exceptions +[System.ArgumentNullException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentNullException 'System.ArgumentNullException') +[systems](#DefaultEcs-System-SequentialSystem-T--SequentialSystem(DefaultEcs-System-ISystem-T---)-systems 'DefaultEcs.System.SequentialSystem<T>.SequentialSystem(DefaultEcs.System.ISystem<T>[]).systems') is null. diff --git a/documentation/api/DefaultEcs-System-SequentialSystem-T--SequentialSystem(System-Collections-Generic-IEnumerable-DefaultEcs-System-ISystem-T--).md b/documentation/api/DefaultEcs-System-SequentialSystem-T--SequentialSystem(System-Collections-Generic-IEnumerable-DefaultEcs-System-ISystem-T--).md index d363918d..a9922454 100644 --- a/documentation/api/DefaultEcs-System-SequentialSystem-T--SequentialSystem(System-Collections-Generic-IEnumerable-DefaultEcs-System-ISystem-T--).md +++ b/documentation/api/DefaultEcs-System-SequentialSystem-T--SequentialSystem(System-Collections-Generic-IEnumerable-DefaultEcs-System-ISystem-T--).md @@ -10,3 +10,6 @@ public SequentialSystem(System.Collections.Generic.IEnumerable -`degreeOfParallelism` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') -The number of [System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') instances used to update a system in parallel. - -#### Exceptions -[System.ArgumentException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentException 'System.ArgumentException') -[degreeOfParallelism](#DefaultEcs-System-SystemRunner-T--SystemRunner(int)-degreeOfParallelism 'DefaultEcs.System.SystemRunner<T>.SystemRunner(int).degreeOfParallelism') cannot be inferior to one. diff --git a/documentation/api/DefaultEcs-System-SystemRunner-T-.md b/documentation/api/DefaultEcs-System-SystemRunner-T-.md deleted file mode 100644 index 367638f8..00000000 --- a/documentation/api/DefaultEcs-System-SystemRunner-T-.md +++ /dev/null @@ -1,20 +0,0 @@ -#### [DefaultEcs](./index.md 'index') -### [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System') -## SystemRunner<T> Class -Represents an helper object used to update a system in parallel. -```C# -public sealed class SystemRunner : -IDisposable -``` -Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') > [SystemRunner<T>](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>') - -Implements [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable 'System.IDisposable') -#### Type parameters - -`T` -The type of the object used as state to update the system. - -### Constructors -- [SystemRunner(int)](./DefaultEcs-System-SystemRunner-T--SystemRunner(int).md 'DefaultEcs.System.SystemRunner<T>.SystemRunner(int)') -### Methods -- [Dispose()](./DefaultEcs-System-SystemRunner-T--Dispose().md 'DefaultEcs.System.SystemRunner<T>.Dispose()') diff --git a/documentation/api/DefaultEcs-System.md b/documentation/api/DefaultEcs-System.md index cc722f61..805b4f35 100644 --- a/documentation/api/DefaultEcs-System.md +++ b/documentation/api/DefaultEcs-System.md @@ -5,11 +5,10 @@ The [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System') namespace co - [AComponentSystem<TState,TComponent>](./DefaultEcs-System-AComponentSystem-TState_TComponent-.md 'DefaultEcs.System.AComponentSystem<TState,TComponent>') - [ActionSystem<T>](./DefaultEcs-System-ActionSystem-T-.md 'DefaultEcs.System.ActionSystem<T>') - [AEntitySystem<T>](./DefaultEcs-System-AEntitySystem-T-.md 'DefaultEcs.System.AEntitySystem<T>') -- [ASystem<T>](./DefaultEcs-System-ASystem-T-.md 'DefaultEcs.System.ASystem<T>') - [ComponentAttribute](./DefaultEcs-System-ComponentAttribute.md 'DefaultEcs.System.ComponentAttribute') +- [DisabledAttribute](./DefaultEcs-System-DisabledAttribute.md 'DefaultEcs.System.DisabledAttribute') - [ParallelSystem<T>](./DefaultEcs-System-ParallelSystem-T-.md 'DefaultEcs.System.ParallelSystem<T>') - [SequentialSystem<T>](./DefaultEcs-System-SequentialSystem-T-.md 'DefaultEcs.System.SequentialSystem<T>') -- [SystemRunner<T>](./DefaultEcs-System-SystemRunner-T-.md 'DefaultEcs.System.SystemRunner<T>') - [WhenAddedAttribute](./DefaultEcs-System-WhenAddedAttribute.md 'DefaultEcs.System.WhenAddedAttribute') - [WhenAddedEitherAttribute](./DefaultEcs-System-WhenAddedEitherAttribute.md 'DefaultEcs.System.WhenAddedEitherAttribute') - [WhenChangedAttribute](./DefaultEcs-System-WhenChangedAttribute.md 'DefaultEcs.System.WhenChangedAttribute') diff --git a/documentation/api/DefaultEcs-Threading-DefaultParallelRunner-DefaultParallelRunner(int).md b/documentation/api/DefaultEcs-Threading-DefaultParallelRunner-DefaultParallelRunner(int).md new file mode 100644 index 00000000..69dcc96d --- /dev/null +++ b/documentation/api/DefaultEcs-Threading-DefaultParallelRunner-DefaultParallelRunner(int).md @@ -0,0 +1,15 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs.Threading](./DefaultEcs-Threading.md 'DefaultEcs.Threading').[DefaultParallelRunner](./DefaultEcs-Threading-DefaultParallelRunner.md 'DefaultEcs.Threading.DefaultParallelRunner') +## DefaultParallelRunner(int) Constructor +Initialises a new instance of the [DefaultParallelRunner](./DefaultEcs-Threading-DefaultParallelRunner.md 'DefaultEcs.Threading.DefaultParallelRunner') class. +```C# +public DefaultParallelRunner(int degreeOfParallelism); +``` +#### Parameters + +`degreeOfParallelism` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') +The number of concurrent [System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task') used to update an [IParallelRunnable](./DefaultEcs-Threading-IParallelRunnable.md 'DefaultEcs.Threading.IParallelRunnable') in parallel. + +#### Exceptions +[System.ArgumentException](https://docs.microsoft.com/en-us/dotnet/api/System.ArgumentException 'System.ArgumentException') +[degreeOfParallelism](#DefaultEcs-Threading-DefaultParallelRunner-DefaultParallelRunner(int)-degreeOfParallelism 'DefaultEcs.Threading.DefaultParallelRunner.DefaultParallelRunner(int).degreeOfParallelism') cannot be inferior to one. diff --git a/documentation/api/DefaultEcs-Threading-DefaultParallelRunner-DegreeOfParallelism.md b/documentation/api/DefaultEcs-Threading-DefaultParallelRunner-DegreeOfParallelism.md new file mode 100644 index 00000000..82775746 --- /dev/null +++ b/documentation/api/DefaultEcs-Threading-DefaultParallelRunner-DegreeOfParallelism.md @@ -0,0 +1,9 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs.Threading](./DefaultEcs-Threading.md 'DefaultEcs.Threading').[DefaultParallelRunner](./DefaultEcs-Threading-DefaultParallelRunner.md 'DefaultEcs.Threading.DefaultParallelRunner') +## DefaultParallelRunner.DegreeOfParallelism Property +Gets the degree of parallelism used to run an [IParallelRunnable](./DefaultEcs-Threading-IParallelRunnable.md 'DefaultEcs.Threading.IParallelRunnable'). +```C# +public int DegreeOfParallelism { get; } +``` +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') diff --git a/documentation/api/DefaultEcs-Threading-DefaultParallelRunner-Dispose().md b/documentation/api/DefaultEcs-Threading-DefaultParallelRunner-Dispose().md new file mode 100644 index 00000000..9c69820c --- /dev/null +++ b/documentation/api/DefaultEcs-Threading-DefaultParallelRunner-Dispose().md @@ -0,0 +1,7 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs.Threading](./DefaultEcs-Threading.md 'DefaultEcs.Threading').[DefaultParallelRunner](./DefaultEcs-Threading-DefaultParallelRunner.md 'DefaultEcs.Threading.DefaultParallelRunner') +## DefaultParallelRunner.Dispose() Method +Releases all the resources used by the current [DefaultParallelRunner](./DefaultEcs-Threading-DefaultParallelRunner.md 'DefaultEcs.Threading.DefaultParallelRunner') instance. +```C# +public void Dispose(); +``` diff --git a/documentation/api/DefaultEcs-Threading-DefaultParallelRunner-Run(DefaultEcs-Threading-IParallelRunnable).md b/documentation/api/DefaultEcs-Threading-DefaultParallelRunner-Run(DefaultEcs-Threading-IParallelRunnable).md new file mode 100644 index 00000000..f80fa49c --- /dev/null +++ b/documentation/api/DefaultEcs-Threading-DefaultParallelRunner-Run(DefaultEcs-Threading-IParallelRunnable).md @@ -0,0 +1,12 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs.Threading](./DefaultEcs-Threading.md 'DefaultEcs.Threading').[DefaultParallelRunner](./DefaultEcs-Threading-DefaultParallelRunner.md 'DefaultEcs.Threading.DefaultParallelRunner') +## DefaultParallelRunner.Run(DefaultEcs.Threading.IParallelRunnable) Method +Runs the provided [IParallelRunnable](./DefaultEcs-Threading-IParallelRunnable.md 'DefaultEcs.Threading.IParallelRunnable'). +```C# +public void Run(DefaultEcs.Threading.IParallelRunnable runnable); +``` +#### Parameters + +`runnable` [IParallelRunnable](./DefaultEcs-Threading-IParallelRunnable.md 'DefaultEcs.Threading.IParallelRunnable') +The [IParallelRunnable](./DefaultEcs-Threading-IParallelRunnable.md 'DefaultEcs.Threading.IParallelRunnable') to run. + diff --git a/documentation/api/DefaultEcs-Threading-DefaultParallelRunner.md b/documentation/api/DefaultEcs-Threading-DefaultParallelRunner.md new file mode 100644 index 00000000..83c9f812 --- /dev/null +++ b/documentation/api/DefaultEcs-Threading-DefaultParallelRunner.md @@ -0,0 +1,19 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs.Threading](./DefaultEcs-Threading.md 'DefaultEcs.Threading') +## DefaultParallelRunner Class +Represents an object used to run an [IParallelRunnable](./DefaultEcs-Threading-IParallelRunnable.md 'DefaultEcs.Threading.IParallelRunnable') by using multiple [System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task'). +```C# +public sealed class DefaultParallelRunner : +IParallelRunner, +IDisposable +``` +Inheritance [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object') > [DefaultParallelRunner](./DefaultEcs-Threading-DefaultParallelRunner.md 'DefaultEcs.Threading.DefaultParallelRunner') + +Implements [IParallelRunner](./DefaultEcs-Threading-IParallelRunner.md 'DefaultEcs.Threading.IParallelRunner'), [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable 'System.IDisposable') +### Constructors +- [DefaultParallelRunner(int)](./DefaultEcs-Threading-DefaultParallelRunner-DefaultParallelRunner(int).md 'DefaultEcs.Threading.DefaultParallelRunner.DefaultParallelRunner(int)') +### Properties +- [DegreeOfParallelism](./DefaultEcs-Threading-DefaultParallelRunner-DegreeOfParallelism.md 'DefaultEcs.Threading.DefaultParallelRunner.DegreeOfParallelism') +### Methods +- [Dispose()](./DefaultEcs-Threading-DefaultParallelRunner-Dispose().md 'DefaultEcs.Threading.DefaultParallelRunner.Dispose()') +- [Run(DefaultEcs.Threading.IParallelRunnable)](./DefaultEcs-Threading-DefaultParallelRunner-Run(DefaultEcs-Threading-IParallelRunnable).md 'DefaultEcs.Threading.DefaultParallelRunner.Run(DefaultEcs.Threading.IParallelRunnable)') diff --git a/documentation/api/DefaultEcs-Threading-IParallelRunnable-Run(int_int).md b/documentation/api/DefaultEcs-Threading-IParallelRunnable-Run(int_int).md new file mode 100644 index 00000000..30e4ba06 --- /dev/null +++ b/documentation/api/DefaultEcs-Threading-IParallelRunnable-Run(int_int).md @@ -0,0 +1,16 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs.Threading](./DefaultEcs-Threading.md 'DefaultEcs.Threading').[IParallelRunnable](./DefaultEcs-Threading-IParallelRunnable.md 'DefaultEcs.Threading.IParallelRunnable') +## IParallelRunnable.Run(int, int) Method +Runs the part [index](#DefaultEcs-Threading-IParallelRunnable-Run(int_int)-index 'DefaultEcs.Threading.IParallelRunnable.Run(int, int).index') out of [maxIndex](#DefaultEcs-Threading-IParallelRunnable-Run(int_int)-maxIndex 'DefaultEcs.Threading.IParallelRunnable.Run(int, int).maxIndex') of the process. +```C# +void Run(int index, int maxIndex); +``` +#### Parameters + +`index` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + + +`maxIndex` [System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') + + diff --git a/documentation/api/DefaultEcs-Threading-IParallelRunnable.md b/documentation/api/DefaultEcs-Threading-IParallelRunnable.md new file mode 100644 index 00000000..3aab6e35 --- /dev/null +++ b/documentation/api/DefaultEcs-Threading-IParallelRunnable.md @@ -0,0 +1,9 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs.Threading](./DefaultEcs-Threading.md 'DefaultEcs.Threading') +## IParallelRunnable Interface +Exposes a method to run a process in parallel. +```C# +public interface IParallelRunnable +``` +### Methods +- [Run(int, int)](./DefaultEcs-Threading-IParallelRunnable-Run(int_int).md 'DefaultEcs.Threading.IParallelRunnable.Run(int, int)') diff --git a/documentation/api/DefaultEcs-Threading-IParallelRunner-DegreeOfParallelism.md b/documentation/api/DefaultEcs-Threading-IParallelRunner-DegreeOfParallelism.md new file mode 100644 index 00000000..3ac61c77 --- /dev/null +++ b/documentation/api/DefaultEcs-Threading-IParallelRunner-DegreeOfParallelism.md @@ -0,0 +1,9 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs.Threading](./DefaultEcs-Threading.md 'DefaultEcs.Threading').[IParallelRunner](./DefaultEcs-Threading-IParallelRunner.md 'DefaultEcs.Threading.IParallelRunner') +## IParallelRunner.DegreeOfParallelism Property +Gets the degree of parallelism used to run an [IParallelRunnable](./DefaultEcs-Threading-IParallelRunnable.md 'DefaultEcs.Threading.IParallelRunnable'). +```C# +int DegreeOfParallelism { get; } +``` +#### Returns +[System.Int32](https://docs.microsoft.com/en-us/dotnet/api/System.Int32 'System.Int32') diff --git a/documentation/api/DefaultEcs-Threading-IParallelRunner-Run(DefaultEcs-Threading-IParallelRunnable).md b/documentation/api/DefaultEcs-Threading-IParallelRunner-Run(DefaultEcs-Threading-IParallelRunnable).md new file mode 100644 index 00000000..d34d6a34 --- /dev/null +++ b/documentation/api/DefaultEcs-Threading-IParallelRunner-Run(DefaultEcs-Threading-IParallelRunnable).md @@ -0,0 +1,12 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs.Threading](./DefaultEcs-Threading.md 'DefaultEcs.Threading').[IParallelRunner](./DefaultEcs-Threading-IParallelRunner.md 'DefaultEcs.Threading.IParallelRunner') +## IParallelRunner.Run(DefaultEcs.Threading.IParallelRunnable) Method +Runs the provided [IParallelRunnable](./DefaultEcs-Threading-IParallelRunnable.md 'DefaultEcs.Threading.IParallelRunnable'). +```C# +void Run(DefaultEcs.Threading.IParallelRunnable runnable); +``` +#### Parameters + +`runnable` [IParallelRunnable](./DefaultEcs-Threading-IParallelRunnable.md 'DefaultEcs.Threading.IParallelRunnable') +The [IParallelRunnable](./DefaultEcs-Threading-IParallelRunnable.md 'DefaultEcs.Threading.IParallelRunnable') to run. + diff --git a/documentation/api/DefaultEcs-Threading-IParallelRunner.md b/documentation/api/DefaultEcs-Threading-IParallelRunner.md new file mode 100644 index 00000000..8848d993 --- /dev/null +++ b/documentation/api/DefaultEcs-Threading-IParallelRunner.md @@ -0,0 +1,13 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs.Threading](./DefaultEcs-Threading.md 'DefaultEcs.Threading') +## IParallelRunner Interface +Exposes a method to run in parallel a [IParallelRunnable](./DefaultEcs-Threading-IParallelRunnable.md 'DefaultEcs.Threading.IParallelRunnable'). +```C# +public interface IParallelRunner : +IDisposable +``` +Implements [System.IDisposable](https://docs.microsoft.com/en-us/dotnet/api/System.IDisposable 'System.IDisposable') +### Properties +- [DegreeOfParallelism](./DefaultEcs-Threading-IParallelRunner-DegreeOfParallelism.md 'DefaultEcs.Threading.IParallelRunner.DegreeOfParallelism') +### Methods +- [Run(DefaultEcs.Threading.IParallelRunnable)](./DefaultEcs-Threading-IParallelRunner-Run(DefaultEcs-Threading-IParallelRunnable).md 'DefaultEcs.Threading.IParallelRunner.Run(DefaultEcs.Threading.IParallelRunnable)') diff --git a/documentation/api/DefaultEcs-Threading.md b/documentation/api/DefaultEcs-Threading.md new file mode 100644 index 00000000..36d0d7bc --- /dev/null +++ b/documentation/api/DefaultEcs-Threading.md @@ -0,0 +1,7 @@ +#### [DefaultEcs](./index.md 'index') +## DefaultEcs.Threading Namespace +### Classes +- [DefaultParallelRunner](./DefaultEcs-Threading-DefaultParallelRunner.md 'DefaultEcs.Threading.DefaultParallelRunner') +### Interfaces +- [IParallelRunnable](./DefaultEcs-Threading-IParallelRunnable.md 'DefaultEcs.Threading.IParallelRunnable') +- [IParallelRunner](./DefaultEcs-Threading-IParallelRunner.md 'DefaultEcs.Threading.IParallelRunner') diff --git a/documentation/api/DefaultEcs-World-GetDisabledEntities().md b/documentation/api/DefaultEcs-World-GetDisabledEntities().md new file mode 100644 index 00000000..2667b2d3 --- /dev/null +++ b/documentation/api/DefaultEcs-World-GetDisabledEntities().md @@ -0,0 +1,10 @@ +#### [DefaultEcs](./index.md 'index') +### [DefaultEcs](./DefaultEcs.md 'DefaultEcs').[World](./DefaultEcs-World.md 'DefaultEcs.World') +## World.GetDisabledEntities() Method +Gets an [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') to create a subset of disabled [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') of the current [World](./DefaultEcs-World.md 'DefaultEcs.World'). +```C# +public DefaultEcs.EntitySetBuilder GetDisabledEntities(); +``` +#### Returns +[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +An [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder'). diff --git a/documentation/api/DefaultEcs-World.md b/documentation/api/DefaultEcs-World.md index 2bb17ec2..7129a4c6 100644 --- a/documentation/api/DefaultEcs-World.md +++ b/documentation/api/DefaultEcs-World.md @@ -20,6 +20,7 @@ Implements [IPublisher](./DefaultEcs-IPublisher.md 'DefaultEcs.IPublisher'), [Sy - [Dispose()](./DefaultEcs-World-Dispose().md 'DefaultEcs.World.Dispose()') - [GetAllComponents<T>()](./DefaultEcs-World-GetAllComponents-T-().md 'DefaultEcs.World.GetAllComponents<T>()') - [GetAllEntities()](./DefaultEcs-World-GetAllEntities().md 'DefaultEcs.World.GetAllEntities()') +- [GetDisabledEntities()](./DefaultEcs-World-GetDisabledEntities().md 'DefaultEcs.World.GetDisabledEntities()') - [GetEntities()](./DefaultEcs-World-GetEntities().md 'DefaultEcs.World.GetEntities()') - [GetMaximumComponentCount<T>()](./DefaultEcs-World-GetMaximumComponentCount-T-().md 'DefaultEcs.World.GetMaximumComponentCount<T>()') - [Publish<T>(T)](./DefaultEcs-World-Publish-T-(T).md 'DefaultEcs.World.Publish<T>(T)') diff --git a/documentation/api/DefaultEcs.md b/documentation/api/DefaultEcs.md index 310b76a4..3922a805 100644 --- a/documentation/api/DefaultEcs.md +++ b/documentation/api/DefaultEcs.md @@ -4,6 +4,7 @@ The [DefaultEcs](./DefaultEcs.md 'DefaultEcs') namespace contains types to put i ### Classes - [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet') - [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder') +- [EitherBuilder](./DefaultEcs-EntitySetBuilder-EitherBuilder.md 'DefaultEcs.EntitySetBuilder.EitherBuilder') - [EntitySetBuilderExtension](./DefaultEcs-EntitySetBuilderExtension.md 'DefaultEcs.EntitySetBuilderExtension') - [IPublisherExtension](./DefaultEcs-IPublisherExtension.md 'DefaultEcs.IPublisherExtension') - [SubscribeAttribute](./DefaultEcs-SubscribeAttribute.md 'DefaultEcs.SubscribeAttribute') diff --git a/documentation/api/index.md b/documentation/api/index.md index 2f1c6f33..dd5bff62 100644 --- a/documentation/api/index.md +++ b/documentation/api/index.md @@ -5,3 +5,4 @@ - [DefaultEcs.Resource](./DefaultEcs-Resource.md 'DefaultEcs.Resource') - [DefaultEcs.Serialization](./DefaultEcs-Serialization.md 'DefaultEcs.Serialization') - [DefaultEcs.System](./DefaultEcs-System.md 'DefaultEcs.System') +- [DefaultEcs.Threading](./DefaultEcs-Threading.md 'DefaultEcs.Threading') diff --git a/source/DefaultEcs/DefaultEcs.Release.csproj b/source/DefaultEcs/DefaultEcs.Release.csproj index eb92518a..b024a4fd 100644 --- a/source/DefaultEcs/DefaultEcs.Release.csproj +++ b/source/DefaultEcs/DefaultEcs.Release.csproj @@ -27,7 +27,7 @@ added EntitySet.Contains method to check for an Entity inclusion added IParallelRunner to allow custom implementation to process AEntitySystem, AComponentSystem and ParallelSystem in parallel added Entity.World property -fixed EntityCommandRecorder SetSameAs and Dispose command size +fixed EntityCommandRecorder SetSameAs and Dispose command fixed size of commands in EntityCommandRecorder fixed size of Entity fixed WithoutEitherAttribute filter generation