Skip to main content

Auki::ConjureKit::Entity

Represents an Entity - an object in a Session with a Pose and an ID that is owned by a specific participant.

Public Functions​

Name
Entity(uint id, uint participantId, EntityFlag and any additional flags
override stringToString()
Prints Entity data into a human-readable string.

Public Attributes​

Name
uintId
Entity id.
uintParticipantId
Entity owner Participant identifier.
EntityFlag type.
IDictionary< uint, EntityComponent >Components
Dictionary containing the collection of EntityComponents on this Entity, indexed by EntityComponent id.

Public Functions Documentation​

function Entity​

Entity(
    uint id,
    uint participantId,
    EntityFlag flag =0
)

Constructs an Entity given an Id, its owner (participantId) and any additional flags

Parameters:

  • id The given id
  • participantId The owning participant id
  • flag Any additional EntityFlag(s)

function ToString​

override string ToString()

Prints Entity data into a human-readable string.

Return: Human-readable string.

Public Attributes Documentation​

variable Id​

uint Id;

Entity id.

variable ParticipantId​

uint ParticipantId;

Entity owner Participant identifier.

variable Flag​

EntityFlag Flag;

Entity type.

variable Components​

IDictionary< uint, EntityComponent > Components = new Dictionary<uint, EntityComponent>();

Dictionary containing the collection of EntityComponents on this Entity, indexed by EntityComponent id.