Entitas  0.35.0
Entitas is a super fast Entity Component System (ECS) Framework specifically made for C# and Unity
Public Member Functions | Properties | List of all members
Entitas.EntityCollector Class Reference

Public Member Functions

 EntityCollector (Group group, GroupEventType eventType)
 
 EntityCollector (Group[] groups, GroupEventType[] eventTypes)
 
void Activate ()
 
void Deactivate ()
 
void ClearCollectedEntities ()
 Clears all collected entities.
 
override string ToString ()
 

Properties

HashSet< EntitycollectedEntities [get]
 

Detailed Description

An EntityCollector can observe one or more groups and collects changed entities based on the specified eventType.

Definition at line 8 of file EntityCollector.cs.

Constructor & Destructor Documentation

§ EntityCollector() [1/2]

Entitas.EntityCollector.EntityCollector ( Group  group,
GroupEventType  eventType 
)
inline

Creates an EntityCollector and will collect changed entities based on the specified eventType.

Definition at line 25 of file EntityCollector.cs.

§ EntityCollector() [2/2]

Entitas.EntityCollector.EntityCollector ( Group []  groups,
GroupEventType []  eventTypes 
)
inline

Creates an EntityCollector and will collect changed entities based on the specified eventTypes.

Definition at line 31 of file EntityCollector.cs.

Member Function Documentation

§ Activate()

void Entitas.EntityCollector.Activate ( )
inline

Activates the EntityCollector and will start collecting changed entities. EntityCollectors are activated by default.

Definition at line 52 of file EntityCollector.cs.

§ Deactivate()

void Entitas.EntityCollector.Deactivate ( )
inline

Deactivates the EntityCollector. This will also clear all collected entities. EntityCollectors are activated by default.

Definition at line 74 of file EntityCollector.cs.

Property Documentation

§ collectedEntities

HashSet<Entity> Entitas.EntityCollector.collectedEntities
get

Returns all collected entities. Call collector.ClearCollectedEntities() once you processed all entities.

Definition at line 13 of file EntityCollector.cs.


The documentation for this class was generated from the following file: