Animation components
Every field below is derived from the engine’s own component registry — the same one the editor’s Details panel reads — so the types and defaults here are the values you get when you add the component, and they cannot drift from the code. The prose that explains how to use each one lives in the guides linked per entry.
Animator
Runs an animator controller — states, transitions and blend trees — over the entity.
Explained in animation/overview.
| Field | Type | Default | Notes |
|---|---|---|---|
controller | Asset<animatorcontroller> | none | |
currentState | string | empty | |
enabled | boolean | true |
DragonBonesAnimation
A DragonBones armature: its skeleton and atlas assets, armature choice and playback state.
Explained in animation/dragonbones.
| Field | Type | Default | Notes |
|---|---|---|---|
skeletonPath | string | empty | |
atlasPath | string | empty | |
armature | enum (dragonbonesArmatures) | empty | |
animation | enum (dragonbonesAnimations) | empty | |
timeScale | number | 1 | Range ≥ 0. |
loop | boolean | true | |
playing | boolean | true | |
fadeInTime | number | 0 | Range ≥ 0, step 0.05. |
flipX | boolean | false | |
flipY | boolean | false | |
color | Color | #ffffff | |
layer | enum (sortingLayers) | 0 | Range step 1. |
skeletonScale | number | 1 | Range ≥ 0. |
material | Asset<material> | none | |
enabled | boolean | true |
SpineAnimation
A Spine skeleton: its skeleton and atlas assets, current animation, skin and mix settings.
Explained in animation/spine.
| Field | Type | Default | Notes |
|---|---|---|---|
skeletonPath | string | empty | |
atlasPath | string | empty | |
skin | enum (spineSkins) | empty | |
animation | enum (spineAnimations) | empty | |
timeScale | number | 1 | Range ≥ 0. |
loop | boolean | true | |
playing | boolean | true | |
flipX | boolean | false | |
flipY | boolean | false | |
color | Color | #ffffff | |
layer | enum (sortingLayers) | 0 | Range step 1. |
skeletonScale | number | 1 | Range ≥ 0. |
material | Asset<material> | none | |
enabled | boolean | true |
SpriteAnimator
Plays a flipbook clip by swapping the sprite frame, with speed, looping and frame events.
Explained in animation/overview.
| Field | Type | Default | Notes |
|---|---|---|---|
clip | Asset<anim-clip> | none | |
speed | number | 1 | |
playing | boolean | true | |
loop | boolean | true | |
enabled | boolean | true | |
currentFrame | number | 0 | |
frameTimer | number | 0 | |
finished | boolean | false |
TimelinePlayer
Plays a timeline asset — keyframed tracks across many entities — with wrap modes and playback control.
Explained in animation/timeline.
| Field | Type | Default | Notes |
|---|---|---|---|
timeline | Asset<timeline> | none | |
playing | boolean | false | |
speed | number | 1 | |
wrapMode | string | "once" | |
finished | boolean | false | Clip completed (runtime, read-only). Raise Playing to replay. |