API Reference

Class List

AnimComponentLayer

The Anim Component Layer allows managers a single layer of the animation state graph.

Summary

Properties

activeState

Returns the currently active state name.[read only]

activeStateCurrentTime

The active states time in seconds.

activeStateDuration

Returns the currently active states duration.[read only]

activeStateProgress

Returns the currently active states progress as a value normalized by the states animation duration.[read only]

name

Returns the name of the layer.[read only]

playable

Returns true if a state graph has been loaded and all states in the graph have been assigned animation tracks.[read only]

playing

Whether this layer is currently playing.

previousState

Returns the previously active state name.[read only]

states

Lists all available states in this layers state graph.[read only]

transitionProgress

If the anim component layer is currently transitioning between states, returns the progress.[read only]

transitioning

Returns whether the anim component layer is currently transitioning between states.[read only]

weight

The blending weight of this layer.

Methods

assignAnimation

Assigns an animation track to a state in the current graph.

assignMask

Add a mask to this layer.

pause

Start playing the animation in the current state.

play

Start playing the animation in the current state.

rebind

Rebind any animations in the layer to the currently present components and model of the anim components entity.

removeNodeAnimations

Removes animations from a node in the loaded state graph.

reset

Reset the animation component to its initial state, including all parameters.

transition

Transition to any state in the current layers graph.

Details

Constructor

AnimComponentLayer(name, controller, component, weight)

Create a new AnimComponentLayer.

Parameters

namestring

The name of the layer.

controllerobject

The controller to manage this layers animations.

componentAnimComponent

The component that this layer is a member of.

weightnumber

The weight of this layer. Defaults to 1.

Properties

stringactiveState

Returns the currently active state name.

[read only]

numberactiveStateCurrentTime

The active states time in seconds.

numberactiveStateDuration

Returns the currently active states duration.

[read only]

numberactiveStateProgress

Returns the currently active states progress as a value normalized by the states animation duration. Looped animations will return values greater than 1.

[read only]

stringname

Returns the name of the layer.

[read only]

stringplayable

Returns true if a state graph has been loaded and all states in the graph have been assigned animation tracks.

[read only]

stringplaying

Whether this layer is currently playing.

stringpreviousState

Returns the previously active state name.

[read only]

string[]states

Lists all available states in this layers state graph.

[read only]

numbertransitionProgress

If the anim component layer is currently transitioning between states, returns the progress. Otherwise returns null.

[read only]

booleantransitioning

Returns whether the anim component layer is currently transitioning between states.

[read only]

numberweight

The blending weight of this layer. Used when calculating the value of properties that are animated by more than one layer.

Methods

assignAnimation(nodeName, animTrack, [speed], [loop])

Assigns an animation track to a state in the current graph. If a state for the given nodeName doesn't exist, it will be created. If all states nodes are linked and the AnimComponent#activate value was set to true then the component will begin playing.

Parameters

nodeNamestring

The name of the node that this animation should be associated with.

animTrackobject

The animation track that will be assigned to this state and played whenever this state is active.

speednumber

Update the speed of the state you are assigning an animation to. Defaults to 1.

loopboolean

Update the loop property of the state you are assigning an animation to. Defaults to true.

assignMask([mask])

Add a mask to this layer.

entity.anim.baseLayer.assignMask({
    // include the spine of the current model and all of its children
    "path/to/spine": {
        children: true
    },
    // include the hip of the current model but not all of its children
    "path/to/hip": true
});

Parameters

maskobject

The mask to assign to the layer. If not provided the current mask in the layer will be removed.

pause()

Start playing the animation in the current state.

play([name])

Start playing the animation in the current state.

Parameters

namestring

If provided, will begin playing from the start of the state with this name.

rebind()

Rebind any animations in the layer to the currently present components and model of the anim components entity.

removeNodeAnimations(nodeName)

Removes animations from a node in the loaded state graph.

Parameters

nodeNamestring

The name of the node that should have its animation tracks removed.

reset()

Reset the animation component to its initial state, including all parameters. The system will be paused.

transition(to, [time], [transitionOffset])

Transition to any state in the current layers graph. Transitions can be instant or take an optional blend time.

Parameters

tostring

The state that this transition will transition to.

timenumber

The duration of the transition in seconds. Defaults to 0.

transitionOffsetnumber

If provided, the destination state will begin playing its animation at this time. Given in normalized time, based on the states duration & must be between 0 and 1. Defaults to null.