Class: AnimationComponent

Single-clip playback (no blending). AnimationSystem samples curves each tick and writes values through auto-dirty setters, so animated property changes propagate naturally. Curves can target descendants — see AnimationClip for path/component/property semantics.

Clips come from two places: clipAssets (ids of .anim clip assets — what the editor authors) and clips (inline AnimationClip data — handy from code). Names must be unique across both; GetClip / Play look in clips first.

Extends

• Component

Constructors

Constructor

new AnimationComponent(): AnimationComponent;

Returns

AnimationComponent

Inherited from

Component.constructor

Properties

Property	Modifier	Type	Default value	Inherited from
clipAssets	public	string[]	undefined	-
clips	public	AnimationClip[]	undefined	-
defaultClip	public	string	undefined	-
dirty	public	boolean	true	Component.dirty
enabled	public	boolean	true	Component.enabled
playOnLoad	public	boolean	undefined	-

Methods

GetClip()

GetClip(name): AnimationClip | undefined;

Parameters

Parameter	Type
name	string

Returns

AnimationClip | undefined

---

GetClips()

GetClips(): AnimationClip[];

Every clip this component can play — inline first, then clip assets.

Returns

AnimationClip[]

---

GetState()

GetState(name): 
  | AnimationState
  | undefined;

Lazy-creates on first ask. Useful for things like anim.GetState('walk').time = 0.5.

Parameters

Parameter	Type
name	string

Returns

| AnimationState | undefined

---

IsPlaying()

IsPlaying(clipName?): boolean;

Parameters

Parameter	Type
clipName?	string

Returns

boolean

---

OnFinished()

OnFinished(cb): AnimationUnsubscribe;

Parameters

Parameter	Type
cb	(s) => void

Returns

AnimationUnsubscribe

---

OnFrameEvent()

OnFrameEvent(name, cb): AnimationUnsubscribe;

Fires once per pass over the named marker in AnimationClip.events.

Parameters

Parameter	Type
name	string
cb	(payload) => void

Returns

AnimationUnsubscribe

---

OnLoopComplete()

OnLoopComplete(cb): AnimationUnsubscribe;

Parameters

Parameter	Type
cb	(s) => void

Returns

AnimationUnsubscribe

---

OnPause()

OnPause(cb): AnimationUnsubscribe;

Parameters

Parameter	Type
cb	(s) => void

Returns

AnimationUnsubscribe

---

OnPlay()

OnPlay(cb): AnimationUnsubscribe;

Parameters

Parameter	Type
cb	(s) => void

Returns

AnimationUnsubscribe

---

OnResume()

OnResume(cb): AnimationUnsubscribe;

Parameters

Parameter	Type
cb	(s) => void

Returns

AnimationUnsubscribe

---

OnStop()

OnStop(cb): AnimationUnsubscribe;

Parameters

Parameter	Type
cb	(s) => void

Returns

AnimationUnsubscribe

---

Pause()

Pause(): void;

Returns

void

---

Play()

Play(clipName?, options?): 
  | AnimationState
  | null;

---------- Playback ---------- Stops the in-flight clip first. Returns null if the name doesn't resolve to a clip.

Parameters

Parameter	Type
clipName?	string
options?	AnimationPlayOptions

Returns

| AnimationState | null

---

PlayClip()

PlayClip(clip, options?): AnimationState;

Plays clip data this component doesn't list (an Animator state's clip asset). Its state is kept under the clip's name, and replaced when a different object arrives (a reload).

Parameters

Parameter	Type
clip	AnimationClip
options?	AnimationPlayOptions

Returns

AnimationState

---

Resume()

Resume(): void;

Returns

void

---

Stop()

Stop(): void;

Returns

void