ClientUIAnimationControl

supers: ClientUIBaseControl

The type that represents an instance of a UI Animation Control component. Contains functions for playing and stopping the specified animation.

The specified animation will automatically play when the component becomes active.

Methods2

function ClientUIAnimationControl:PlayAnimation()

Plays the UI animation. If already playing, the animation is restarted.

function ClientUIAnimationControl:StopAnimation()

Stops the UI animation.

Fields3

ClientUIAnimationControl.animationId : integer

[Read/Write] The animation ID. Assigning a different ID while active will immediately play the new animation.

ClientUIAnimationControl.playSoundEffect : boolean

[Read/Write] Whether to play animation sound effects. Toggling this value from false to true while active will replay the corresponding sound effect, even if the animation has finished.

ClientUIAnimationControl.layer : EnumItem.UIAnimationLayer

[Read/Write] The animation layer.