Talos docs

SwayTuning

Since 0.7

How a body sways: a gain and a limit per channel, and the spring they share.

Plain text

Signature

export interface SwayTuning {
  /** Radians of pitch per m/s² of forward acceleration: nose up as it pulls away, down as it brakes. */
  pitch: number
  /** Radians of roll per m/s² of sideways acceleration; positive leans out of the turn (a car), negative into it (a bike). */
  roll: number
  /** Metres of bob per m/s² of upward acceleration: down as it lands, up as it drops away. */
  bob: number
  /** The largest pitch either way, radians. */
  maxPitch: number
  /** The largest roll either way, radians. */
  maxRoll: number
  /** The largest bob either way, metres. */
  maxBob: number
  /** The spring's natural frequency, Hz: how quickly the body catches up with the frame. */
  frequency: number
  /** Damping ratio: 1 settles without overshoot, below 1 rocks a little before it settles. */
  damping: number
}

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

Members

MemberSignatureDescription
pitchpitch: numberRadians of pitch per m/s² of forward acceleration: nose up as it pulls away, down as it brakes.
rollroll: numberRadians of roll per m/s² of sideways acceleration; positive leans out of the turn (a car), negative into it (a bike).
bobbob: numberMetres of bob per m/s² of upward acceleration: down as it lands, up as it drops away.
maxPitchmaxPitch: numberThe largest pitch either way, radians.
maxRollmaxRoll: numberThe largest roll either way, radians.
maxBobmaxBob: numberThe largest bob either way, metres.
frequencyfrequency: numberThe spring's natural frequency, Hz: how quickly the body catches up with the frame.
dampingdamping: numberDamping ratio: 1 settles without overshoot, below 1 rocks a little before it settles.