AnimLayer

See AnimLayer in the contract.

Signature

export interface AnimLayer {
  /** How a script names the layer; unique in the animator. */
  name: string
  /** The bones it acts on, each with its descendants. Absent: all of them. */
  mask?: string[]
  /** Bones, with their descendants, taken back out of `mask`. */
  maskExclude?: string[]
  /** A weight 0..1 for a bone and its descendants within the mask. */
  maskWeights?: Record<string, number>
  /** True: add the clip's change from its reference pose on top of the pose below, instead of replacing it. */
  additive?: boolean
  /** How strongly the layer applies, 0..1, default 1; see `ctx.animator.layerWeight`. */
  weight?: number
  /** A float parameter that drives the weight each tick instead of `weight`. */
  weightParam?: string
  /** Seconds the layer takes to fade in when something starts playing on it. */
  blendIn?: number
  /** Seconds the layer takes to fade out when its playback ends or is stopped. */
  blendOut?: number
  /** Additive only: the clip whose pose is the reference, and where in it (0..1, default 0). */
  reference?: string
  /** Where in the reference clip the reference pose is, 0..1, default 0. */
  referenceAt?: number
  /** A state the layer plays from the start, held while nothing else plays on it. Absent: empty until a script plays something on it. */
  initial?: string
}

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

Members