LocomotionProps

Since 0.6

Signature

export interface LocomotionProps {
  /** The blend parameter to drive. Default `"speed"`. */
  parameter?: string
  /** The animation event the animator raises for a footfall. Default `"footstep"`. */
  footstepEvent?: string
  /** An audio asset to play on each footstep. Omitted plays nothing. */
  cue?: string
  /** The bus the cue plays on. Default `"sfx"`. */
  bus?: string
  /**
   * Multiplies the speed written to the parameter, for a tree authored in something other
   * than m/s — a 0..1 gait, say. Default 1.
   */
  scale?: number
}

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

Members

Member	Signature	Description
`parameter`	`parameter?: string`	The blend parameter to drive. Default `"speed"`.
`footstepEvent`	`footstepEvent?: string`	The animation event the animator raises for a footfall. Default `"footstep"`.
`cue`	`cue?: string`	An audio asset to play on each footstep. Omitted plays nothing.
`bus`	`bus?: string`	The bus the cue plays on. Default `"sfx"`.
`scale`	`scale?: number`	Multiplies the speed written to the parameter, for a tree authored in something other than m/s — a 0..1 gait, say. Default 1.