Class: AnimatorComponent

Runs an animation graph (.animgraph asset) on the entity's AnimationComponent: plays the entry state's clip, then follows transitions as parameters change and clips reach their exit times. Gameplay code drives it through the parameters:

animator.SetBool('running', true);
animator.SetTrigger('jump');

AnimatorSystem does the work (Update phase, before AnimationSystem). The AnimationComponent's own Play On Load should be off — the graph decides what plays.

Extends

• Component

Constructors

Constructor

new AnimatorComponent(): AnimatorComponent;

Returns

AnimatorComponent

Inherited from

Component.constructor

Properties

Property	Modifier	Type	Default value	Inherited from
dirty	public	boolean	true	Component.dirty
enabled	public	boolean	true	Component.enabled
graph	public	string	undefined	-

Methods

GetBool()

GetBool(name): boolean;

Parameters

Parameter	Type
name	string

Returns

boolean

---

GetCurrentState()

GetCurrentState(): string | null;

Returns

string | null

---

GetNumber()

GetNumber(name): number;

Parameters

Parameter	Type
name	string

Returns

number

---

IsInState()

IsInState(name): boolean;

Parameters

Parameter	Type
name	string

Returns

boolean

---

OnStateEnter()

OnStateEnter(cb): AnimatorUnsubscribe;

Parameters

Parameter	Type
cb	(state, previous) => void

Returns

AnimatorUnsubscribe

---

Play()

Play(state): void;

Jumps straight to a state (next tick), skipping transitions.

Parameters

Parameter	Type
state	string

Returns

void

---

ResetTrigger()

ResetTrigger(name): void;

Parameters

Parameter	Type
name	string

Returns

void

---

SetBool()

SetBool(name, value): void;

Parameters

Parameter	Type
name	string
value	boolean

Returns

void

---

SetNumber()

SetNumber(name, value): void;

Parameters

Parameter	Type
name	string
value	number

Returns

void

---

SetTrigger()

SetTrigger(name): void;

Held until a transition consumes it (or ResetTrigger).

Parameters

Parameter	Type
name	string

Returns

void