Animation

Skeletal Animations

Animates descendant skinned meshes with the referenced animation graph and animation set. the skeleton of the skinned meshes and animations in animation set need to be compatible.

Entity

Animation Controller

Entity Component

Animation Controller animation_controller

Drives skeletal animation using an Animation Graph and Animation Set; animates descendant skinned meshes whose skeletons are compatible with the set.

Schema

animationGraphRef

UUID(animation_graph Asset)

Referenced Animation Graph (UUID).

Referenced Animation Graph (UUID).

animationSetRef

UUID(animation_set Asset)

Referenced Animation Set (UUID).

Referenced Animation Set (UUID).

dataJSON

JSON

Animation Graph input parameters in JSON format.

Animation Graph input parameters in JSON format.

rootBoneEntityRef

Entity Reference

Entity containing the Bone component for the skeleton's root bone.

Entity containing the Bone component for the skeleton's root bone.

rootMotionEnabled

Boolean

Default:false

Enable root motion extraction and application to the entity transform.

Enable root motion extraction and application to the entity transform.

View in component reference

Marks this mesh as skinned with the referenced skeleton.

Entity

Skeleton Reference

Entity Component

Skeleton Reference skeleton_ref

Reference to a skeleton asset for skinning and animation.

Schema

value

UUID(skeleton Asset)

Referenced skeleton (UUID).

Referenced skeleton (UUID).

View in component reference

Mesh Reference

Entity Component

Mesh Reference mesh_ref

Reference to a mesh to render (with submesh selection).

Schema

shadowCastingMode

Unsigned Byte

Default:1(On)

Min:0

Shadow casting mode for this mesh.

0Off1On

Shadow casting mode for this mesh.

submeshIndex

Integer

Default:0

Index of the submesh within the mesh's submesh array.

Index of the submesh within the mesh's submesh array.

value

UUID(mesh Asset)

Referenced mesh (UUID).

Referenced mesh (UUID).

View in component reference

One of

Material Reference

Entity Component

Material Reference material_ref

Reference to a material to use for rendering.

Schema

faceCulling

Integer

Default:0(Inherit from material)

Face culling override: 0 = inherit from material, 1 = single-sided, 2 = double-sided.

0Inherit from material1Single Sided2Double Sided

Face culling override: 0 = inherit from material, 1 = single-sided, 2 = double-sided.

value

UUID(material Asset)

Referenced material (UUID).

Referenced material (UUID).

View in component reference

Material

Entity Component

Material material

Assigns a shader to the entity's mesh and provides its input values and specialization constants.

Schema

constantsJSON

JSON

Specialization constants (JSON); schema defined by shaderRef.

Specialization constants (JSON); schema defined by shaderRef.

dataJSON

JSON

Shader input values (JSON); schema defined by shaderRef.

Shader input values (JSON); schema defined by shaderRef.

isDoubleSided

Boolean

Default:false

Render both front and back faces (double-sided).

Render both front and back faces (double-sided).

shaderRef

UUID(shader Asset)

Referenced shader (UUID).

Referenced shader (UUID).

View in component reference

Is the root bone.

Entity

Bone

Entity Component

Bone bone

Associates this entity with a bone in a skeleton (for attachments and transforms).

Schema

boneIndex

Unsigned Integer

Min:0

Zero-based index of this bone within the bound skeleton.

Zero-based index of this bone within the bound skeleton.

View in component reference

Skeleton Reference

Entity Component

Skeleton Reference skeleton_ref

Reference to a skeleton asset for skinning and animation.

Schema

value

UUID(skeleton Asset)

Referenced skeleton (UUID).

Referenced skeleton (UUID).

View in component reference

Is a bone.

Entity

Bone

Entity Component

Bone bone

Associates this entity with a bone in a skeleton (for attachments and transforms).

Schema

boneIndex

Unsigned Integer

Min:0

Zero-based index of this bone within the bound skeleton.

Zero-based index of this bone within the bound skeleton.

View in component reference

Animation Sequences

An instance of an animation sequence with entities set to its tracks.

Entity

Animation Sequence Controller

Entity Component

Animation Sequence Controller animation_sequence_controller

Controls playback of an Animation Sequence; assigns tracks to entities.

Schema

animationSequenceRef

UUID(animation_sequence Asset)

Referenced Animation Sequence (UUID).

Referenced Animation Sequence (UUID).

entities

Map<UUID, Entity Reference>

Map from track UUID to assigned entity.

Map from track UUID to assigned entity.

loop

Boolean

Default:false

Loop playback when reaching the stop offset.

Loop playback when reaching the stop offset.

playbackSpeed

Float

Default:1

Playback speed multiplier. Negative values play in reverse.

Playback speed multiplier. Negative values play in reverse.

startOffset

Float

Default:0

Min:0

Max:1

Normalized start offset [0, 1].

Normalized start offset [0, 1].

stopOffset

Float

Default:1

Min:0

Max:1

Normalized stop offset [0, 1]. When looping, playback wraps to startOffset at this point.

Normalized stop offset [0, 1]. When looping, playback wraps to startOffset at this point.

View in component reference