Skip to main content

Auki::ConjureKit::ECS::ISystem

Definition for Systems interface.

Inherited by Auki.ConjureKit.ECS.SystemBase

Public Functions​

Name
string[]GetComponentTypeNames()
Will be invoked by ConjureKit and has to return an array of all component type names that the System will use.
voidUpdate(IReadOnlyList<(EntityComponent component, bool localChange)> updated)
Invoked by ConjureKit when EntityComponents are altered.
voidDelete(IReadOnlyList<(EntityComponent component, bool localChange)> deleted)
Invoked by ConjureKit when EntityComponent are removed.

Public Functions Documentation​

function GetComponentTypeNames​

string[] GetComponentTypeNames()

Will be invoked by ConjureKit and has to return an array of all component type names that the System will use.

Return: Array of component type names

Reimplemented by: Auki::ConjureKit::ECS::SystemBase::GetComponentTypeNames

function Update​

void Update(
    IReadOnlyList<(EntityComponent component, bool localChange)> updated
)

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

Reimplemented by: Auki::ConjureKit::ECS::SystemBase::Update

function Delete​

void Delete(
    IReadOnlyList<(EntityComponent component, bool localChange)> deleted
)

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

Reimplemented by: Auki::ConjureKit::ECS::SystemBase::Delete