ForgeDocs
Documentation for the forge framework
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Pages
Forge.Entities.BaseSystem Class Reference

All systems need to extend the system class. Systems have callbacks automatically registered by implementing ITrigger* interfaces. More...

Inheritance diagram for Forge.Entities.BaseSystem:
Forge.Entities.ISystem Forge.Entities.Tests.SystemCounter

Protected Member Functions

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...
 

Properties

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...
 

Additional Inherited Members

Detailed Description

All systems need to extend the system class. Systems have callbacks automatically registered by implementing ITrigger* interfaces.

Client code should not directly extend this, as it does not give any behavior by itself.

Member Function Documentation

virtual SystemExecutionOrdering Forge.Entities.BaseSystem.GetExecutionOrdering ( ISystem  system)
protectedvirtual

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.

Parameters
systemThe system to compare our execution ordering against.
Returns
The order that execution needs to happen in.

Implements Forge.Entities.ISystem.

Property Documentation

EntityIndex Forge.Entities.BaseSystem.EntityIndex
getsetprotected

Returns the EntityIndex, which can be used to lookup entities by their UniqueIds.

IEventDispatcher Forge.Entities.BaseSystem.EventDispatcher
getsetprotected

Get the event dispatcher that can be used to notify the external world of events.

IEntity Forge.Entities.BaseSystem.GlobalEntity
getsetprotected

Get the global entity that can be used to store global data.

TemplateIndex Forge.Entities.BaseSystem.TemplateIndex
getsetprotected

Returns the TemplateIndex, when can be used to lookup templates by their TemplateIds.


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