 | EntityManager Class |
Creates and removes game entities. Holds references to all component
managers, delegating all calls for adding or removing components.
Inheritance HierarchyNamespace: Slash.ECS.Components
Assembly: Slash.ECS (in Slash.ECS.dll) Version: 1.0.6018.40178
SyntaxThe EntityManager type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | EntityManager |
Constructs a new entity manager without any initial entities.
|
Properties| Name | Description | |
|---|---|---|
 | Entities |
Read-only collection of all entities.
|
| EntityCount |
Total number of entities managed by this EntityManager instance.
|
Methods| Name | Description | |
|---|---|---|
| ActivateEntity |
Re-activates the entity with the specified id, if it is inactive.
|
| AddComponent(Int32, IEntityComponent) |
Attaches the passed component to the entity with the specified id.
|
| AddComponent(Int32, IEntityComponent, Boolean) |
Attaches the passed component to the entity with the specified id.
|
| AddComponent(Type, Int32, IAttributeTable) |
Adds a component with the specified type to entity with the
specified id and initializes it with the values taken from
the passed attribute table.
|
| AddComponentT(Int32) |
Attaches a new component of the passed type to the entity with the specified id.
|
| CleanUpEntities |
Removes all entities that have been issued for removal during the
current tick, detaching all components.
|
| ComponentsOfType |
Returns an iterator over all components of the specified type.
|
| CreateEntity |
Creates a new entity.
|
| CreateEntity(Int32) |
Creates a new entity with the specified id.
|
| DeactivateEntity |
De-activates the entity with the specified id. Inactive entities
are considered as removed, until they are re-activated again.
|
| EntitiesWithComponent |
Returns an iterator over all entities having components of the specified type attached.
|
| EntityIsAlive |
Checks whether the entity with the passed id has been removed or
not.
|
| EntityIsBeingRemoved |
Checks if the entity with the specified id will be removed this
frame.
|
| EntityIsInactive |
Checks whether the entity with the specified id is inactive.
|
| GetComponent(Int32, Type, Boolean) |
Gets a component of the passed type attached to the entity with the specified id.
|
| GetComponentT(Int32) |
Gets a component of the passed type attached to the entity with the specified id.
|
| GetComponents |
Returns all components of the entity with the specified id.
|
| GetEntities |
Retrieves an array containing the ids of all living entities in
O(n).
|
| GetEntities(FuncInt32, Boolean) |
Returns the entity ids of all entities which fulfill the specified predicate.
|
| GetEntityComponentTComponent |
Convenience method for retrieving a component from two possible entities.
|
| GetEntityComponentsTComponentTypeA, TComponentTypeB |
Convenience method for retrieving components from two entities
in case the order of the entities is unknown.
|
| InitEntity |
Initializes the specified entity, adding the specified components.
|
| OnEntityInitialized |
Called when the entity with the specified id was initialized.
TODO(co): This shouldn't be public.
|
| RegisterComponentListeners(Type, ComponentAddedDelegateObject, ComponentRemovedDelegateObject) |
Registers listeners to track adding/removing of components of specified component type.
|
| RegisterComponentListenersT(ComponentAddedDelegateT, ComponentRemovedDelegateT) |
Registers listeners to track adding/removing of components of type T.
|
| RemoveComponent |
Removes a component of the passed type from the entity with the specified id.
|
| RemoveEntities |
Removes all entities.
|
| RemoveEntity | Issues the entity with the specified id for removal at the end of the current tick. If the entity is inactive, it is removed immediately and no further event is raised. |
| TryGetComponent(Int32, Type, IEntityComponent) |
Tries to get a component of the passed type attached to the entity with the specified id.
|
| TryGetComponentT(Int32, T) |
Tries to get a component of the passed type attached to the entity with the specified id.
|
Events| Name | Description | |
|---|---|---|
 | EntityInitialized |
Entity has been created and all components have been added and initialized.
|
| EntityRemoved |
Entity and all of its components will be removed at the end of this tick.
|
Extension Methods| Name | Description | |
|---|---|---|
 | CreateEntity |
Creates a new entity, adding components matching the passed
blueprint and initializing these with the data stored in the
blueprint and the specified configuration. Configuration data
is preferred over blueprint data.
(Defined by EntityManagerExtensions.) |
| InitEntity |
Initializes the specified entity, adding components matching the
passed blueprint and initializing these with the data stored in
the blueprint and the specified configuration. Configuration
data is preferred over blueprint data.
(Defined by EntityManagerExtensions.) |
See Also