updated documentation and readme

Doraku · Jun 23, 2019 · 7ba16de · 7ba16de
1 parent b65f7fe
commit 7ba16de
Show file tree

Hide file tree

Showing 37 changed files with 210 additions and 103 deletions.
diff --git a/README.md b/README.md
@@ -164,6 +164,27 @@ EntitySet set = world.GetEntities().WithAny<Example, int>().Build();
 Span<Example> components = world.GetAllComponents<Example>();
 ```
 
+There is also some special rules which will make the EntitySet react to some events
+```C#
+// this set when enumerated will give all the entities on which an Example component has been added for the first time
+EntitySet set = world.GetEntities().WhenAdded<Example>().Build();
+
+// this set when enumerated will give all the entities on which the Example component has been explicitly changed with Entity.Set<Example> method
+EntitySet set = world.GetEntities().WhenChanged<Example>().Build();
+
+// this set when enumerated will give all the entities on which the Example component has been removed
+EntitySet set = world.GetEntities().WhenRemoved<Example>().Build();
+
+// this set when enumerated will give all the entities on which the Example component has been added or changed
+EntitySet set = world.GetEntities().WhenAdded<Example>().WhenChanged<Example>().Build();
+
+// this set when enumerated will give all the entities with an int component on which the Example component has been changed, the order is important
+EntitySet set = world.GetEntities().With<int>().WhenChanged<Example>().Build();
+```
+
+Note that if such a rule is used, the method `Complete` of the EntitySet needs to be called once every Entity has been processed to clear the EntitySet of its content.  
+Calling this method on an EntitySet created with only static filtering will do nothing.
+
 Although there is no obligation, a set of base classes are provided to help the creation of systems:
 <a name='Overview_System_ISystem'></a>
 ### ISystem<T>

diff --git a/documentation/api/DefaultEcs-Entity-Disable-T-().md b/documentation/api/DefaultEcs-Entity-Disable-T-().md
@@ -1,7 +1,8 @@
 #### [DefaultEcs](./DefaultEcs.md 'DefaultEcs')
 ### [DefaultEcs](./DefaultEcs.md#DefaultEcs 'DefaultEcs').[Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity')
 ## Disable&lt;T&gt;() `method`
-Disables the current [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') component of type [T](#DefaultEcs-Entity-Disable-T-()-T 'DefaultEcs.Entity.Disable&lt;T&gt;().T') so it does not appear in [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet').
+Disables the current [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') component of type [T](#DefaultEcs-Entity-Disable-T-()-T 'DefaultEcs.Entity.Disable&lt;T&gt;().T') so it does not appear in [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet').  
+Does nothing if current [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') does not have a component of type [T](#DefaultEcs-Entity-Disable-T-()-T 'DefaultEcs.Entity.Disable&lt;T&gt;().T').
 ### Type parameters
 
 <a name='DefaultEcs-Entity-Disable-T-()-T'></a>

diff --git a/documentation/api/DefaultEcs-EntitySet-Complete().md b/documentation/api/DefaultEcs-EntitySet-Complete().md
@@ -0,0 +1,6 @@
+#### [DefaultEcs](./DefaultEcs.md 'DefaultEcs')
+### [DefaultEcs](./DefaultEcs.md#DefaultEcs 'DefaultEcs').[EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet')
+## Complete() `method`
+Clears current instance of its entities if it was created with some reactive filter ([WhenAdded&lt;T&gt;()](./DefaultEcs-EntitySetBuilder-WhenAdded-T-().md 'DefaultEcs.EntitySetBuilder.WhenAdded&lt;T&gt;()'), [WhenChanged&lt;T&gt;()](./DefaultEcs-EntitySetBuilder-WhenChanged-T-().md 'DefaultEcs.EntitySetBuilder.WhenChanged&lt;T&gt;()') or [WhenRemoved&lt;T&gt;()](./DefaultEcs-EntitySetBuilder-WhenRemoved-T-().md 'DefaultEcs.EntitySetBuilder.WhenRemoved&lt;T&gt;()')).  
+Does nothing if it was created from a static filter.  
+This method need to be called after current instance content has been processed in a update cycle.
diff --git a/...-EntitySetObserverEvents-OnEntityAdded.md → ...n/api/DefaultEcs-EntitySet-EntityAdded.md b/...-EntitySetObserverEvents-OnEntityAdded.md → ...n/api/DefaultEcs-EntitySet-EntityAdded.md
@@ -1,4 +1,4 @@
 #### [DefaultEcs](./DefaultEcs.md 'DefaultEcs')
-### [DefaultEcs](./DefaultEcs.md#DefaultEcs 'DefaultEcs').[EntitySetObserverEvents](./DefaultEcs-EntitySetObserverEvents.md 'DefaultEcs.EntitySetObserverEvents')
-## OnEntityAdded `event`
+### [DefaultEcs](./DefaultEcs.md#DefaultEcs 'DefaultEcs').[EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet')
+## EntityAdded `event`
 Event called when an [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') is added to the [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet').
diff --git a/...ntitySetObserverEvents-OnEntityRemoved.md → ...api/DefaultEcs-EntitySet-EntityRemoved.md b/...ntitySetObserverEvents-OnEntityRemoved.md → ...api/DefaultEcs-EntitySet-EntityRemoved.md
@@ -1,4 +1,4 @@
 #### [DefaultEcs](./DefaultEcs.md 'DefaultEcs')
-### [DefaultEcs](./DefaultEcs.md#DefaultEcs 'DefaultEcs').[EntitySetObserverEvents](./DefaultEcs-EntitySetObserverEvents.md 'DefaultEcs.EntitySetObserverEvents')
-## OnEntityRemoved `event`
+### [DefaultEcs](./DefaultEcs.md#DefaultEcs 'DefaultEcs').[EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet')
+## EntityRemoved `event`
 Event called when an [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') is removed from the [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet').
diff --git a/documentation/api/DefaultEcs-EntitySet.md b/documentation/api/DefaultEcs-EntitySet.md
@@ -2,8 +2,12 @@
 ### [DefaultEcs](./DefaultEcs.md#DefaultEcs 'DefaultEcs')
 ## EntitySet `type`
 Represents a sub-selection of [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') instances from a [World](./DefaultEcs-World.md 'DefaultEcs.World').
+### Events
+- [EntityAdded](./DefaultEcs-EntitySet-EntityAdded.md 'DefaultEcs.EntitySet.EntityAdded')
+- [EntityRemoved](./DefaultEcs-EntitySet-EntityRemoved.md 'DefaultEcs.EntitySet.EntityRemoved')
 ### Properties
 - [Count](./DefaultEcs-EntitySet-Count.md 'DefaultEcs.EntitySet.Count')
 ### Methods
+- [Complete()](./DefaultEcs-EntitySet-Complete().md 'DefaultEcs.EntitySet.Complete()')
 - [Dispose()](./DefaultEcs-EntitySet-Dispose().md 'DefaultEcs.EntitySet.Dispose()')
 - [GetEntities()](./DefaultEcs-EntitySet-GetEntities().md 'DefaultEcs.EntitySet.GetEntities()')
diff --git a/...ntation/api/DefaultEcs-EntitySetBuilder-Build(DefaultEcs-IEntitySetObserver).md b/...ntation/api/DefaultEcs-EntitySetBuilder-Build(DefaultEcs-IEntitySetObserver).md
diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-WhenAdded(System-Type--).md b/documentation/api/DefaultEcs-EntitySetBuilder-WhenAdded(System-Type--).md
@@ -0,0 +1,12 @@
+#### [DefaultEcs](./DefaultEcs.md 'DefaultEcs')
+### [DefaultEcs](./DefaultEcs.md#DefaultEcs 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.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.
+### Parameters
+
+<a name='DefaultEcs-EntitySetBuilder-WhenAdded(System-Type--)-componentTypes'></a>
+`componentTypes`
+
+The types of component.
+### Returns
+The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder').
diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-WhenAdded-T-().md b/documentation/api/DefaultEcs-EntitySetBuilder-WhenAdded-T-().md
@@ -0,0 +1,12 @@
+#### [DefaultEcs](./DefaultEcs.md 'DefaultEcs')
+### [DefaultEcs](./DefaultEcs.md#DefaultEcs 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder')
+## WhenAdded&lt;T&gt;() `method`
+Makes a rule to observe [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when a component of type [T](#DefaultEcs-EntitySetBuilder-WhenAdded-T-()-T 'DefaultEcs.EntitySetBuilder.WhenAdded&lt;T&gt;().T') is added.
+### Type parameters
+
+<a name='DefaultEcs-EntitySetBuilder-WhenAdded-T-()-T'></a>
+`T`
+
+The type of component.
+### Returns
+The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder').
diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-WhenChanged(System-Type--).md b/documentation/api/DefaultEcs-EntitySetBuilder-WhenChanged(System-Type--).md
@@ -0,0 +1,12 @@
+#### [DefaultEcs](./DefaultEcs.md 'DefaultEcs')
+### [DefaultEcs](./DefaultEcs.md#DefaultEcs 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.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.
+### Parameters
+
+<a name='DefaultEcs-EntitySetBuilder-WhenChanged(System-Type--)-componentTypes'></a>
+`componentTypes`
+
+The types of component.
+### Returns
+The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder').
diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-WhenChanged-T-().md b/documentation/api/DefaultEcs-EntitySetBuilder-WhenChanged-T-().md
@@ -0,0 +1,12 @@
+#### [DefaultEcs](./DefaultEcs.md 'DefaultEcs')
+### [DefaultEcs](./DefaultEcs.md#DefaultEcs 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder')
+## WhenChanged&lt;T&gt;() `method`
+Makes a rule to observe [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when a component of type [T](#DefaultEcs-EntitySetBuilder-WhenChanged-T-()-T 'DefaultEcs.EntitySetBuilder.WhenChanged&lt;T&gt;().T') is changed.
+### Type parameters
+
+<a name='DefaultEcs-EntitySetBuilder-WhenChanged-T-()-T'></a>
+`T`
+
+The type of component.
+### Returns
+The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder').
diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-WhenRemoved(System-Type--).md b/documentation/api/DefaultEcs-EntitySetBuilder-WhenRemoved(System-Type--).md
@@ -0,0 +1,12 @@
+#### [DefaultEcs](./DefaultEcs.md 'DefaultEcs')
+### [DefaultEcs](./DefaultEcs.md#DefaultEcs 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.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.
+### Parameters
+
+<a name='DefaultEcs-EntitySetBuilder-WhenRemoved(System-Type--)-componentTypes'></a>
+`componentTypes`
+
+The types of component.
+### Returns
+The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder').
diff --git a/documentation/api/DefaultEcs-EntitySetBuilder-WhenRemoved-T-().md b/documentation/api/DefaultEcs-EntitySetBuilder-WhenRemoved-T-().md
@@ -0,0 +1,12 @@
+#### [DefaultEcs](./DefaultEcs.md 'DefaultEcs')
+### [DefaultEcs](./DefaultEcs.md#DefaultEcs 'DefaultEcs').[EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder')
+## WhenRemoved&lt;T&gt;() `method`
+Makes a rule to observe [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') when a component of type [T](#DefaultEcs-EntitySetBuilder-WhenRemoved-T-()-T 'DefaultEcs.EntitySetBuilder.WhenRemoved&lt;T&gt;().T') is removed.
+### Type parameters
+
+<a name='DefaultEcs-EntitySetBuilder-WhenRemoved-T-()-T'></a>
+`T`
+
+The type of component.
+### Returns
+The current [EntitySetBuilder](./DefaultEcs-EntitySetBuilder.md 'DefaultEcs.EntitySetBuilder').
diff --git a/documentation/api/DefaultEcs-EntitySetBuilder.md b/documentation/api/DefaultEcs-EntitySetBuilder.md
@@ -4,7 +4,12 @@
 Represent an helper object to create an [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet') to retrieve specific subset of [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity').
 ### Methods
 - [Build()](./DefaultEcs-EntitySetBuilder-Build().md 'DefaultEcs.EntitySetBuilder.Build()')
-- [Build(DefaultEcs.IEntitySetObserver)](./DefaultEcs-EntitySetBuilder-Build(DefaultEcs-IEntitySetObserver).md 'DefaultEcs.EntitySetBuilder.Build(DefaultEcs.IEntitySetObserver)')
+- [WhenAdded&lt;T&gt;()](./DefaultEcs-EntitySetBuilder-WhenAdded-T-().md 'DefaultEcs.EntitySetBuilder.WhenAdded&lt;T&gt;()')
+- [WhenAdded(System.Type[])](./DefaultEcs-EntitySetBuilder-WhenAdded(System-Type--).md 'DefaultEcs.EntitySetBuilder.WhenAdded(System.Type[])')
+- [WhenChanged&lt;T&gt;()](./DefaultEcs-EntitySetBuilder-WhenChanged-T-().md 'DefaultEcs.EntitySetBuilder.WhenChanged&lt;T&gt;()')
+- [WhenChanged(System.Type[])](./DefaultEcs-EntitySetBuilder-WhenChanged(System-Type--).md 'DefaultEcs.EntitySetBuilder.WhenChanged(System.Type[])')
+- [WhenRemoved&lt;T&gt;()](./DefaultEcs-EntitySetBuilder-WhenRemoved-T-().md 'DefaultEcs.EntitySetBuilder.WhenRemoved&lt;T&gt;()')
+- [WhenRemoved(System.Type[])](./DefaultEcs-EntitySetBuilder-WhenRemoved(System-Type--).md 'DefaultEcs.EntitySetBuilder.WhenRemoved(System.Type[])')
 - [With&lt;T&gt;()](./DefaultEcs-EntitySetBuilder-With-T-().md 'DefaultEcs.EntitySetBuilder.With&lt;T&gt;()')
 - [With(System.Type[])](./DefaultEcs-EntitySetBuilder-With(System-Type--).md 'DefaultEcs.EntitySetBuilder.With(System.Type[])')
 - [WithAny(System.Type[])](./DefaultEcs-EntitySetBuilder-WithAny(System-Type--).md 'DefaultEcs.EntitySetBuilder.WithAny(System.Type[])')

diff --git a/documentation/api/DefaultEcs-EntitySetObserverEvents.md b/documentation/api/DefaultEcs-EntitySetObserverEvents.md
diff --git a/...mentation/api/DefaultEcs-IEntitySetObserver-OnEntityAdded(DefaultEcs-Entity).md b/...mentation/api/DefaultEcs-IEntitySetObserver-OnEntityAdded(DefaultEcs-Entity).md
diff --git a/...ntation/api/DefaultEcs-IEntitySetObserver-OnEntityRemoved(DefaultEcs-Entity).md b/...ntation/api/DefaultEcs-IEntitySetObserver-OnEntityRemoved(DefaultEcs-Entity).md
diff --git a/documentation/api/DefaultEcs-IEntitySetObserver.md b/documentation/api/DefaultEcs-IEntitySetObserver.md
diff --git a/...stem-AEntitySystem-T---ctor(DefaultEcs-World-_DefaultEcs-IEntitySetObserver).md b/...stem-AEntitySystem-T---ctor(DefaultEcs-World-_DefaultEcs-IEntitySetObserver).md
diff --git a/...Ecs-World-_DefaultEcs-IEntitySetObserver-_DefaultEcs-System-SystemRunner-T-).md b/...Ecs-World-_DefaultEcs-IEntitySetObserver-_DefaultEcs-System-SystemRunner-T-).md
diff --git a/documentation/api/DefaultEcs-System-AEntitySystem-T--EntityAdded.md b/documentation/api/DefaultEcs-System-AEntitySystem-T--EntityAdded.md
@@ -0,0 +1,4 @@
+#### [DefaultEcs](./DefaultEcs.md 'DefaultEcs')
+### [DefaultEcs.System](./DefaultEcs.md#DefaultEcs-System 'DefaultEcs.System').[AEntitySystem&lt;T&gt;](./DefaultEcs-System-AEntitySystem-T-.md 'DefaultEcs.System.AEntitySystem&lt;T&gt;')
+## EntityAdded `event`
+Event called when an [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') is added to the inner [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet').
diff --git a/documentation/api/DefaultEcs-System-AEntitySystem-T--EntityRemoved.md b/documentation/api/DefaultEcs-System-AEntitySystem-T--EntityRemoved.md
@@ -0,0 +1,4 @@
+#### [DefaultEcs](./DefaultEcs.md 'DefaultEcs')
+### [DefaultEcs.System](./DefaultEcs.md#DefaultEcs-System 'DefaultEcs.System').[AEntitySystem&lt;T&gt;](./DefaultEcs-System-AEntitySystem-T-.md 'DefaultEcs.System.AEntitySystem&lt;T&gt;')
+## EntityRemoved `event`
+Event called when an [Entity](./DefaultEcs-Entity.md 'DefaultEcs.Entity') is removed from the inner [EntitySet](./DefaultEcs-EntitySet.md 'DefaultEcs.EntitySet').
diff --git a/documentation/api/DefaultEcs-System-AEntitySystem-T--PostUpdate(T).md b/documentation/api/DefaultEcs-System-AEntitySystem-T--PostUpdate(T).md
@@ -0,0 +1,10 @@
+#### [DefaultEcs](./DefaultEcs.md 'DefaultEcs')
+### [DefaultEcs.System](./DefaultEcs.md#DefaultEcs-System 'DefaultEcs.System').[AEntitySystem&lt;T&gt;](./DefaultEcs-System-AEntitySystem-T-.md 'DefaultEcs.System.AEntitySystem&lt;T&gt;')
+## PostUpdate(T) `method`
+Performs a post-update treatment.
+### Parameters
+
+<a name='DefaultEcs-System-AEntitySystem-T--PostUpdate(T)-state'></a>
+`state`
+
+The state to use.