AnimComponent(system, entity) 

Create a new AnimComponent.

Parameters

system	AnimComponentSystem	The ComponentSystem that created this Component.
entity	Entity	The Entity that this Component is attached to.

booleanactivate 

If true the first animation will begin playing when the scene is loaded.

{{TYPE-ERROR}}addLayer 

Adds a new anim component layer to the anim component.

AnimComponentLayerbaseLayer 

Returns the base layer of the state graph.

[read only]

booleanplayable 

Returns whether all component layers are currently playable.

[read only]

booleanplaying 

Plays or pauses all animations in the component.

EntityrootBone 

The entity that this anim component should use as the root of the animation hierarchy.

numberspeed 

Speed multiplier for animation play back speed. 1.0 is playback at normal speed, 0.0 pauses the animation.

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

Associates an animation with a state in the loaded state graph. If all states are linked and the AnimComponent#activate value was set to true then the component will begin playing. If no state graph is loaded, a default state graph will be created with a single state based on the provided nodeName parameter.

Parameters

nodeName	string	The name of the state node that this animation should be associated with.
animTrack	object	The animation track that will be assigned to this state and played whenever this state is active.
layerName	string	The name of the anim component layer to update. If omitted the default layer is used. If no state graph has been previously loaded this parameter is ignored.
speed	number	Update the speed of the state you are assigning an animation to. Defaults to 1.
loop	boolean	Update the loop property of the state you are assigning an animation to. Defaults to true.

findAnimationLayer(name) 

Finds a AnimComponentLayer in this component.

Parameters

name

string

The name of the anim component layer to find.

Returns

AnimComponentLayer

Layer.

getBoolean(name) 

Returns a boolean parameter value by name.

Parameters

name

string

The name of the boolean to return the value of.

Returns

boolean

A boolean.

getFloat(name) 

Returns a float parameter value by name.

Parameters

name

string

The name of the float to return the value of.

Returns

number

A float.

getInteger(name) 

Returns an integer parameter value by name.

Parameters

name

string

The name of the integer to return the value of.

Returns

number

An integer.

getTrigger(name) 

Returns a trigger parameter value by name.

Parameters

name

string

The name of the trigger to return the value of.

Returns

boolean

A boolean.

loadStateGraph(stateGraph) 

Initialises component animation controllers using the provided state graph.

entity.anim.loadStateGraph({
    "layers": [
        {
            "name": layerName,
            "states": [
                {
                    "name": "START",
                    "speed": 1
                },
                {
                    "name": "Initial State",
                    "speed": speed,
                    "loop": loop,
                    "defaultState": true
                }
            ],
            "transitions": [
                {
                    "from": "START",
                    "to": "Initial State"
                }
            ]
        }
    ],
    "parameters": {}
});

Parameters

stateGraph

object

The state graph asset to load into the component. Contains the states, transitions and parameters used to define a complete animation controller.

rebind() 

Rebind all of the components layers.

removeNodeAnimations(nodeName, [layerName]) 

Removes animations from a node in the loaded state graph.

Parameters

nodeName	string	The name of the node that should have its animation tracks removed.
layerName	string	The name of the anim component layer to update. If omitted the default layer is used.

removeStateGraph() 

Removes all layers from the anim component.

reset() 

Reset all of the components layers and parameters to their initial states. If a layer was playing before it will continue playing.

resetTrigger(name) 

Resets the value of a trigger parameter that was defined in the animation components state graph to false.

Parameters

name

string

The name of the parameter to set.

setBoolean(name, value) 

Sets the value of a boolean parameter that was defined in the animation components state graph.

Parameters

name	string	The name of the parameter to set.
value	boolean	The new boolean value to set this parameter to.

setFloat(name, value) 

Sets the value of a float parameter that was defined in the animation components state graph.

Parameters

name	string	The name of the parameter to set.
value	number	The new float value to set this parameter to.

setInteger(name, value) 

Sets the value of an integer parameter that was defined in the animation components state graph.

Parameters

name	string	The name of the parameter to set.
value	number	The new integer value to set this parameter to.

setTrigger(name, [singleFrame]) 

Sets the value of a trigger parameter that was defined in the animation components state graph to true.

Parameters

name	string	The name of the parameter to set.
singleFrame	boolean	If true, this trigger will be set back to false at the end of the animation update. Defaults to false.

ComponentSystemsystem 

The ComponentSystem used to create this Component.

Entityentity 

The Entity that this Component is attached to.

booleanenabled 

Enables or disables the component.