Auki::ConjureKit::ECS::SystemBase
Base class for ConjureKit Systems. Methods are going to be called by ConjureKit.
Inherits from Auki.ConjureKit.ECS.ISystem
Inherited by Auki.ConjureKit.ECS.PoseSystem
Public Functions
Name | |
---|---|
virtual abstract string[] | GetComponentTypeNames() =0 Will be invoked by ConjureKit and has to return an array of all component type names that the System will use. |
virtual abstract void | Update(IReadOnlyList<(EntityComponent component, bool localChange)> updated) =0 Invoked by ConjureKit when EntityComponents are altered. |
virtual abstract void | Delete(IReadOnlyList<(EntityComponent component, bool localChange)> deleted) =0 Invoked by ConjureKit when EntityComponent are removed. |
Protected Functions
Name | |
---|---|
SystemBase(Session session) System constructor with session instance |
Protected Attributes
Name | |
---|---|
readonly Session | _session Session instance used by the system. |
Public Functions Documentation
function GetComponentTypeNames
virtual abstract string[] GetComponentTypeNames() =0
Will be invoked by ConjureKit and has to return an array of all component type names that the System will use.
Reimplements: Auki::ConjureKit::ECS::ISystem::GetComponentTypeNames
Reimplemented by: Auki::ConjureKit::ECS::PoseSystem::GetComponentTypeNames
function Update
virtual abstract void Update(
IReadOnlyList<(EntityComponent component, bool localChange)> updated
) =0
Invoked by ConjureKit when EntityComponents are altered.
Reimplements: Auki::ConjureKit::ECS::ISystem::Update
Reimplemented by: Auki::ConjureKit::ECS::PoseSystem::Update
function Delete
virtual abstract void Delete(
IReadOnlyList<(EntityComponent component, bool localChange)> deleted
) =0
Invoked by ConjureKit when EntityComponent are removed.
Reimplements: Auki::ConjureKit::ECS::ISystem::Delete
Reimplemented by: Auki::ConjureKit::ECS::PoseSystem::Delete
Protected Functions Documentation
function SystemBase
SystemBase(
Session session
)
System constructor with session instance
Parameters:
- session The session instance
Protected Attributes Documentation
variable _session
readonly Session _session;
Session instance used by the system.