Documentation / scene / AnimationControllerSetStateOptions

Type Alias: AnimationControllerSetStateOptions

AnimationControllerSetStateOptions = object

Defined in: libs/scene/src/animation/animationcontroller.ts:42

Options used when switching the controller to another state.

Properties

transition?

optional transition?: number

Defined in: libs/scene/src/animation/animationcontroller.ts:44

Cross-fade duration (seconds). Overrides the target state's own transition.

---

sync?

optional sync?: AnimationPlaybackSyncOptions

Defined in: libs/scene/src/animation/animationcontroller.ts:49

Optional phase synchronization source applied to entry play steps that do not already define their own options.sync.

---

force?

optional force?: boolean

Defined in: libs/scene/src/animation/animationcontroller.ts:51

Re-enter the state even if it is already current. Defaults to false (no-op on same state).

---

stop?

optional stop?: StopAnimationOptions

Defined in: libs/scene/src/animation/animationcontroller.ts:53

Stop options for the outgoing state when no cross-fade is used.

---

returnTo?

optional returnTo?: AnimationTimelineStateReturnTarget

Defined in: libs/scene/src/animation/animationcontroller.ts:60

Optional state to enter when the target state completes.

Use true to return to the state active before this transition, or a string to return to a specific named state.

---

returnTransition?

optional returnTransition?: number

Defined in: libs/scene/src/animation/animationcontroller.ts:66

Optional transition duration used when returning from the target state.

If omitted, the return state's own transition setting is used.