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

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

string[] GetComponentTypeNames()

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

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

function Update

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

Invoked by ConjureKit when EntityComponents are altered. updatedList 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

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

Invoked by ConjureKit when EntityComponent are removed. deletedList 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
)

System constructor with session instance.

Parameters:

  • session The session instance

Protected Attributes Documentation

variable _session

readonly Session _session;

Session instance used by the system.