Skip to main content

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
Returns an array of all component type names that the System will use.
virtual abstract voidUpdate(IReadOnlyList<(EntityComponent component, bool localChange)> updated) =0
Invoked by ConjureKit when EntityComponents are altered.
virtual abstract voidDelete(IReadOnlyList<(EntityComponent component, bool localChange)> deleted) =0
Invoked by ConjureKit when EntityComponent are removed.

Protected Functions​

Name
SystemBase(Session session)

Protected Attributes​

Name
readonly Session_session

Public Functions Documentation​

function GetComponentTypeNames​

virtual abstract string[] GetComponentTypeNames() =0

Returns an array of all component type names that the System will use.

Return: Array of component type names

Reimplements: Auki::ConjureKit::ECS::ISystem::GetComponentTypeNames

function Update​

virtual abstract void Update(
    IReadOnlyList<(EntityComponent component, bool localChange)> updated
) =0

Invoked by ConjureKit when EntityComponents are altered.

Parameters:

  • updated List of pairs of the form (EntityComponent, bool) in chronological order of updated EntityComponents since the last invocation of the same function, possibly containing the same Component on the same Entity several times. The boolean indicates whether the change to the EntityComponent was effected by the local participant (true) or by a remote participant (false).

Reimplements: Auki::ConjureKit::ECS::ISystem::Update

function Delete​

virtual abstract void Delete(
    IReadOnlyList<(EntityComponent component, bool localChange)> deleted
) =0

Invoked by ConjureKit when EntityComponent are removed.

Parameters:

  • deleted List of pairs of the form (EntityComponent, bool) in chronological order of deleted EntityComponents. The boolean indicates whether the deletion was performed by the local participant (true) or by a remote participant (false).

Reimplements: Auki::ConjureKit::ECS::ISystem::Delete

Protected Functions Documentation​

function SystemBase​

SystemBase(
    Session session
)

Protected Attributes Documentation​

variable _session​

readonly Session _session;