Documentation
Home Animation Channels Guide Clips Guide No-Code Guide API Reference

Class BeastRushSettings

Editable parameters used by the Rush clip.

Inheritance
object
BeastRushSettings
Namespace: CreatureKit.Beasts.Animation
Assembly: CreatureKit.Beasts.Animation.Runtime.dll
Syntax
public sealed class BeastRushSettings
Remarks

Inspector ranges describe recommended authoring values: speed is 0 to 4, cycle speed is 0.1 to 6 cycles per second before the speed multiplier, phase offsets are -1 to 1 normalized cycle units, and angle amplitudes are expressed in degrees.

Constructors

BeastRushSettings()

Declaration
public BeastRushSettings()

Fields

bodyBobHeight

Vertical body movement during the rush cycle.

Declaration
public float bodyBobHeight
Field Value
Type Description
float

bodyLungeLength

Forward/backward body translation during the rush cycle.

Declaration
public float bodyLungeLength
Field Value
Type Description
float

bodyPitchDegrees

Forward/backward body pitch synced with the rush cycle.

Declaration
public float bodyPitchDegrees
Field Value
Type Description
float

bodyRollDegrees

Side-to-side body roll synced with alternating rush leg motion.

Declaration
public float bodyRollDegrees
Field Value
Type Description
float

cyclesPerSecond

Number of full rush cycles played per second before the speed multiplier is applied.

Declaration
public float cyclesPerSecond
Field Value
Type Description
float

earFlapDegrees

Ear flap angle driven by the Rush clip when the Ears channel is enabled.

Declaration
public float earFlapDegrees
Field Value
Type Description
float

earPhaseOffset

Cycle offset for ear motion relative to the main rush cycle.

Declaration
public float earPhaseOffset
Field Value
Type Description
float

earPitchDegrees

Forward/backward ear pitch angle driven by the Rush clip when the Ears channel is enabled.

Declaration
public float earPitchDegrees
Field Value
Type Description
float

earYawDegrees

Side-to-side ear yaw angle driven by the Rush clip when the Ears channel is enabled.

Declaration
public float earYawDegrees
Field Value
Type Description
float

enabledChannels

Animation channels driven by Rush.

Declaration
public BeastAnimationChannels enabledChannels
Field Value
Type Description
BeastAnimationChannels

eyePhaseOffset

Cycle offset for eye motion relative to the main rush cycle.

Declaration
public float eyePhaseOffset
Field Value
Type Description
float

eyePitchDegrees

Up/down visible-eye pitch driven by the Rush clip when the Eyes channel is enabled.

Declaration
public float eyePitchDegrees
Field Value
Type Description
float

eyeYawDegrees

Side-to-side visible-eye yaw driven by the Rush clip when the Eyes channel is enabled.

Declaration
public float eyeYawDegrees
Field Value
Type Description
float

footSwingPitchDegrees

Pitch applied to the foot while it leaves and returns to the ground.

Declaration
public float footSwingPitchDegrees
Field Value
Type Description
float

headBobHeight

Vertical head bob layered on top of the rush motion.

Declaration
public float headBobHeight
Field Value
Type Description
float

headPhaseOffset

Cycle offset for head motion relative to the main rush cycle.

Declaration
public float headPhaseOffset
Field Value
Type Description
float

headPitchDegrees

Forward/backward head pitch during Rush.

Declaration
public float headPitchDegrees
Field Value
Type Description
float

headYawDegrees

Side-to-side head yaw during Rush.

Declaration
public float headYawDegrees
Field Value
Type Description
float

lowerLegFoldDegrees

Maximum lower-leg fold during the recovery part of the rush step.

Declaration
public float lowerLegFoldDegrees
Field Value
Type Description
float

mouthOpenDegrees

Mouth opening angle driven by the Rush clip when the Mouth channel is enabled.

Declaration
public float mouthOpenDegrees
Field Value
Type Description
float

mouthPhaseOffset

Cycle offset for mouth opening relative to the main rush cycle.

Declaration
public float mouthPhaseOffset
Field Value
Type Description
float

neckBobHeight

Vertical neck bob driven by the Rush clip when the Neck channel is enabled.

Declaration
public float neckBobHeight
Field Value
Type Description
float

neckPhaseOffset

Cycle offset for neck motion relative to the main rush cycle.

Declaration
public float neckPhaseOffset
Field Value
Type Description
float

neckPitchDegrees

Forward/backward neck pitch driven by the Rush clip when the Neck channel is enabled.

Declaration
public float neckPitchDegrees
Field Value
Type Description
float

neckYawDegrees

Side-to-side neck yaw driven by the Rush clip when the Neck channel is enabled.

Declaration
public float neckYawDegrees
Field Value
Type Description
float

sidePhaseOffsetPercent

Phase offset between left and right sides.

Declaration
public float sidePhaseOffsetPercent
Field Value
Type Description
float

speed

Runtime multiplier applied by controllers to scale Rush playback.

Declaration
public float speed
Field Value
Type Description
float

stancePercent

Percent of the cycle spent in the planted or pushing part of the rush step.

Declaration
public float stancePercent
Field Value
Type Description
float

stepHeight

Visual lift used to derive fallback leg motion.

Declaration
public float stepHeight
Field Value
Type Description
float

strideLength

Multiplier for the forward/backward upper-leg swing.

Declaration
public float strideLength
Field Value
Type Description
float

tailPhaseOffset

Cycle offset for tail motion relative to the main rush cycle.

Declaration
public float tailPhaseOffset
Field Value
Type Description
float

tailPitchDegrees

Tail pitch amplitude driven by the Rush clip when the Tail channel is enabled.

Declaration
public float tailPitchDegrees
Field Value
Type Description
float

tailRollDegrees

Tail roll amplitude driven by the Rush clip when the Tail channel is enabled.

Declaration
public float tailRollDegrees
Field Value
Type Description
float

tailYawDegrees

Tail yaw amplitude driven by the Rush clip when the Tail channel is enabled.

Declaration
public float tailYawDegrees
Field Value
Type Description
float

upperLegPitchDegrees

Maximum forward/backward pitch applied to the upper leg in FK rush motion.

Declaration
public float upperLegPitchDegrees
Field Value
Type Description
float

waveSpreadPercent

How much the rush phase travels from front leg pairs to rear leg pairs.

Declaration
public float waveSpreadPercent
Field Value
Type Description
float