Documentation / scene / AnimationMarker

Type Alias: AnimationMarker

AnimationMarker = object

Defined in: libs/scene/src/animation/animation.ts:29

Timeline marker metadata stored on an animation clip.

Markers are data, not callbacks. Runtime systems may dispatch events when a playback cursor crosses the marker.

Properties

id?

optional id?: string

Defined in: libs/scene/src/animation/animation.ts:31

Stable marker id for editor and blueprint references.

---

name

name: string

Defined in: libs/scene/src/animation/animation.ts:33

Display/event name.

---

time?

optional time?: number

Defined in: libs/scene/src/animation/animation.ts:35

Marker time in seconds.

---

frame?

optional frame?: number

Defined in: libs/scene/src/animation/animation.ts:37

Marker frame. Converted with fps or the owning clip's frameRate.

---

fps?

optional fps?: number

Defined in: libs/scene/src/animation/animation.ts:39

Optional frame rate used for frame conversion.

---

payload?

optional payload?: unknown

Defined in: libs/scene/src/animation/animation.ts:41

Serializable user payload.