ForgeDocs
Documentation for the forge framework
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Pages
Forge.Entities.Tests.SystemCounter Class Reference
Inheritance diagram for Forge.Entities.Tests.SystemCounter:
Forge.Entities.BaseSystem Forge.Entities.Trigger.Update Forge.Entities.Trigger.Removed Forge.Entities.ISystem Forge.Entities.ISystem Forge.Entities.ITriggerFilterProvider Forge.Entities.ISystem Forge.Entities.ITriggerFilterProvider Forge.Entities.ISystem Forge.Entities.ISystem

Public Member Functions

void OnUpdate (IEntity entity)
 This is called every update frame for all entities which pass the filter. More...
 
void OnRemoved (IEntity entity)
 Called when an Entity, which was once passing the filter, is no longer doing so. More...
 

Public Attributes

int UpdateCount
 
int RemovedCount
 
Type[] Filter
 

Properties

Type[] RequiredDataTypes [get]
 
- Properties inherited from Forge.Entities.BaseSystem
IEventDispatcher EventDispatcher [get, set]
 Get the event dispatcher that can be used to notify the external world of events. More...
 
IEntity GlobalEntity [get, set]
 Get the global entity that can be used to store global data. More...
 
EntityIndex EntityIndex [get, set]
 Returns the EntityIndex, which can be used to lookup entities by their UniqueIds. More...
 
TemplateIndex TemplateIndex [get, set]
 Returns the TemplateIndex, when can be used to lookup templates by their TemplateIds. More...
 
- Properties inherited from Forge.Entities.ISystem
IEventDispatcher EventDispatcher [set]
 Set the event dispatcher that can be used to notify the external world of events. More...
 
IEntity GlobalEntity [set]
 Set the global entity that can be used to store global data. More...
 
EntityIndex EntityIndex [set]
 Set the entity index. More...
 
TemplateIndex TemplateIndex [set]
 Set the template index. More...
 
- Properties inherited from Forge.Entities.ITriggerFilterProvider
Type[] RequiredDataTypes [get]
 Computes the entity filter. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Forge.Entities.BaseSystem
virtual SystemExecutionOrdering GetExecutionOrdering (ISystem system)
 Return the order of system execution for this system relative to the given system. This method defaults to SystemExecutionOrdering.Concurrent, which means that there is no explicit execution ordering required between the two systems. More...
 

Member Function Documentation

void Forge.Entities.Tests.SystemCounter.OnRemoved ( IEntity  entity)

Called when an Entity, which was once passing the filter, is no longer doing so.

This can occur for a number of reasons, such as a data state change or the Entity being destroyed.

Parameters
entityAn entity that is no longer passing the filter.

Implements Forge.Entities.Trigger.Removed.

void Forge.Entities.Tests.SystemCounter.OnUpdate ( IEntity  entity)

This is called every update frame for all entities which pass the filter.

If you need to know when the entities are added or are no longer going to be updated, also implement ILifecycleTrigger.

Parameters
entityAn entity which has passed the filter.

Implements Forge.Entities.Trigger.Update.


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