Auki::ConjureKit::ECS::IPoseSystem
Represents a system for managing entity poses.
Inherited by Auki.ConjureKit.ECS.PoseSystem
Public Events
Name | |
---|---|
Action< Entity > | OnEntityUpdatePose() Event triggered when an entity's Pose is updated. |
Public Functions
Name | |
---|---|
void | AddEntityPose(uint entityId, Pose pose, Action onComplete, Action< string > onError) Adds a Pose to an existing entity. This will attach a new component of auki.pose to the given entity. |
bool | UpdateEntityPose(uint entityId, Pose pose) Tries to update the Pose of an existing entity. |
Pose | GetEntityPose(uint entityId) Queries the Pose of a specific entity. |
Pose | GetEntityPose(Entity entity) Queries the Pose of a specific entity. |
Public Events Documentation
event OnEntityUpdatePose
Action< Entity > OnEntityUpdatePose()
Event triggered when an entity's Pose is updated.
Public Functions Documentation
function AddEntityPose
void AddEntityPose(
uint entityId,
Pose pose,
Action onComplete,
Action< string > onError
)
Adds a Pose to an existing entity. This will attach a new component of auki.pose
to the given entity.
Parameters:
- entityId The ID of the entity to which the Pose will be added.
- pose The Pose to add to the entity.
- onComplete An action to execute upon successful completion.
- onError An action to execute if an error occurs during the operation.
Reimplemented by: Auki::ConjureKit::ECS::PoseSystem::AddEntityPose
function UpdateEntityPose
bool UpdateEntityPose(
uint entityId,
Pose pose
)
Tries to update the Pose of an existing entity.
Parameters:
- entityId The ID of the entity to update the Pose for.
- pose The new Pose to set for the entity.
Return: False if the entity does not exist or if the entity does not have an auki.pose
component attached.
Reimplemented by: Auki::ConjureKit::ECS::PoseSystem::UpdateEntityPose
function GetEntityPose
Pose GetEntityPose(
uint entityId
)
Queries the Pose of a specific entity.
Parameters:
- entityId The ID of the entity for which to retrieve the Pose.
Return: The entity's Pose if the entity has an auki.pose
component attached; otherwise, returns a default Pose.
Reimplemented by: Auki::ConjureKit::ECS::PoseSystem::GetEntityPose
function GetEntityPose
Pose GetEntityPose(
Entity entity
)
Queries the Pose of a specific entity.
Parameters:
- entity The entity for which to retrieve the Pose.
Return: The entity's Pose if the entity has an auki.pose
component attached; otherwise, returns a default Pose.
Reimplemented by: Auki::ConjureKit::ECS::PoseSystem::GetEntityPose