isAnimationPlaying

Script::isAnimationPlaying

Checks if an Entity is currently playing a certain Animation.

Declaration

bool isAnimationPlaying(Entity entity, uint32_t animationIndex);

Parameters

Name

Type

Description

entity

Entity

The Entity to check the Animation’s status of. It must have a Renderable Component.

animationIndex

uint32_t

The animation to check the status of, indexed on entity's Renderable’s model’s Animation list.

Returns

true if the Animation is currently playing on the Entity, else, returns false.