Talos docs

LocomotionState

Since 0.6
Plain text

Signature

export interface LocomotionState {
  /** Footsteps heard since this behavior was attached. */
  steps: number
  /** The last value written to the parameter, or the last speed seen when the engine drives it. */
  speed: number
  /** True when the scene bound the parameter to a controller fact, so the engine drives it. */
  engineDriven: boolean
  /** False when the animator has no such parameter; the behavior then does nothing. */
  bound: boolean
  /**
   * False when this behavior would have to drive the parameter and has nothing to drive it
   * with: no `source` on the parameter and no `controller` component to read a velocity
   * from. The blend then sits on its first clip, which `init` says once.
   */
  driveable: boolean
}

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

Members

MemberSignatureDescription
stepssteps: numberFootsteps heard since this behavior was attached.
speedspeed: numberThe last value written to the parameter, or the last speed seen when the engine drives it.
engineDrivenengineDriven: booleanTrue when the scene bound the parameter to a controller fact, so the engine drives it.
boundbound: booleanFalse when the animator has no such parameter; the behavior then does nothing.
driveabledriveable: booleanFalse when this behavior would have to drive the parameter and has nothing to drive it with: no source on the parameter and no controller component to read a velocity from. The blend then sits on its first clip, which init says once.