Talos docs

AnimEvent

Since 0.6Changed in 0.7
Plain text

Signature

export interface AnimEvent {
  clip: string
  /** 0..1 of the clip. Exactly one of `at` and `frame`. */
  at?: number
  /** A frame on the 30 Hz clip grid, instead of `at`. */
  frame?: number
  /** Makes the event a window `[at, until)`, delivered with `phase: "begin"` and `"end"`. */
  until?: number
  /** `until` as a frame, with `frame`. */
  untilFrame?: number
  event: string
  /** Free-form values delivered as `data.data` of the event. */
  data?: Record<string, unknown>
}

Import: import type { AnimEvent } from "@argus/gameplay"

Members

MemberSignatureDescription
clipclip: string
atat?: number0..1 of the clip. Exactly one of at and frame.
frameframe?: numberA frame on the 30 Hz clip grid, instead of at.
untiluntil?: numberMakes the event a window [at, until), delivered with phase: "begin" and "end".
untilFrameuntilFrame?: numberuntil as a frame, with frame.
eventevent: string
datadata?: Record<string, unknown>Free-form values delivered as data.data of the event.