LuaStudio API documentation

absoluteTime

[read-only] Returns the internal absolute time of the animator, calculated by the current time and the playback speed. (Float)

activeAnimation

[read-only] Returns the current active animation node. (AnimationNodeBase)

activeAnimationName

[read-only] Returns the current active animation node. String

activeState

[read-only] Returns the current active animation state. IAnimationState (AnimationStateBase)

assetType

[read-only] The type of the asset. String

autoUpdate

Determines whether the animators internal update mechanisms are active. Boolean

playbackSpeed

The amount by which passed time should be scaled. (Float)

time

Gets and sets the internal time clock of the animator. (Int)

updatePosition

Enables translation of the animated mesh from data returned per frame via the positionDelta property of the active animation node.. Boolean

dispose()

Cleans up resources used by this asset.

getAnimationState(node)

Return (AnimationStateBase)

node - (AnimationNodeBase)

getAnimationStateByName(name)

Return (AnimationStateBase)

name - String

phase(value)

Sets the animation phase of the current active state's animation clip(s).

value - The phase value to use. 0 represents the beginning of an animation clip, 1 represents the end.

reset(name, offset)

name - String

offset - (default = 0)

start()

Resumes the automatic playback clock controling the active state of the animator.

stop()

Pauses the automatic playback clock of the animator, in case manual updates are required via the time property or update() method.

update(time)

Provides a way to manually update the active state of the animator when automatic updates are disabled.

time - Int