Improved documentation and removed some old code

This commit is contained in:
Mergul 2020-05-06 10:55:40 +02:00
parent 5411e97cb1
commit 46aba822d0
3 changed files with 21 additions and 40 deletions

View file

@ -14,16 +14,16 @@ System contain data required to proper glue EntityManager with Systems.
System callbacks:
$(LIST
* void onUpdate(EntitesData);
* void onEnable()
* void onDisable();
* bool onBegin();
* void onEnd();
* void onCreate()
* void onDestroy();
* void onAddEntity(EntitesData);
* void onRemoveEntity(EntitiesData);
* void onChangeEntity(EntitiesData);
* void handleEvent(Entity*, Event);
* void onEnable() - called inside system.enable() function
* void onDisable() - called inside system.disable() function
* bool onBegin() - called inside manager.begin()
* void onEnd() - called inside manager.end()
* void onCreate() - called after registration inside registerSystem function
* void onDestroy() - called during re-registration and inside manager destructor
* void onAddEntity(EntitesData) - called for every entity which are assigned to system (by adding new entity or changing its components)
* void onRemoveEntity(EntitiesData) - called for every entity removed from system update process
* void onChangeEntity(EntitiesData) - called for every entity which components are changed but it was previously assigned to system
* void handleEvent(Entity*, Event) - called for every event supported by system
)
*/
struct System
@ -66,15 +66,15 @@ struct System
}
/************************************************************************************************************************
Get system priority.
Get if system will be executed during current frame. Should be checked after manager.begin(). Its value is setted as result of manager.onBegin() callback.
*/
export bool execute() nothrow @nogc
export bool willExecute() nothrow @nogc
{
return m_execute;
}
/************************************************************************************************************************
Get system priority.
Get system id.
*/
export ushort id() nothrow @nogc
{