Class LocomotionForces

Namespace

Trailblazer.Navigation.Motor

Assembly

Trailblazer.dll

Holds the gravity and terminal velocity forces applied to a object, with support for per-instance overrides and global defaults.

public sealed class LocomotionForces : IRecordable

Inheritance

object

LocomotionForces

Implements

IRecordable

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

LocomotionForces()

public LocomotionForces()

Fields

GlobalForces

Simulation-wide gravity defaults applied to all MoveLocomotion instances that do not carry a per-instance override.

public static readonly GlobalEnvironmentForces GlobalForces

Field Value

GlobalEnvironmentForces

Remarks

Assign fields on this instance to shift gravity for every unoverridden object at once. Call Reset() to restore the defaults.

Properties

GravityForce

The gravity force applied to this object. Returns the per-instance override when one is set; otherwise delegates to GlobalEnvironmentForces so a single global change takes effect for all unoverridden navigators simultaneously. Assigning this property sets the per-instance override. Call ClearGravityForceOverride() to remove the override and restore global tracking.

public Fixed64 GravityForce { get; set; }

Property Value

Fixed64

HasGravityForceOverride

Returns true when this instance carries a per-instance gravity override. When false, GravityForce follows GlobalEnvironmentForces.

public bool HasGravityForceOverride { get; }

Property Value

bool

HasTerminalVelocityOverride

Returns true when this instance carries a per-instance terminal velocity override. When false, TerminalVelocity follows GlobalEnvironmentForces.

public bool HasTerminalVelocityOverride { get; }

Property Value

bool

TerminalVelocity

The terminal fall velocity cap for this object. Returns the per-instance override when one is set; otherwise delegates to GlobalEnvironmentForces. Assigning this property sets the per-instance override. Call ClearTerminalVelocityOverride() to remove the override and restore global tracking.

public Fixed64 TerminalVelocity { get; set; }

Property Value

Fixed64

Methods

ClearGravityForceOverride()

Removes the per-instance gravity override so this object tracks GlobalEnvironmentForces.

public void ClearGravityForceOverride()

ClearTerminalVelocityOverride()

Removes the per-instance terminal velocity override so this object tracks GlobalEnvironmentForces.

public void ClearTerminalVelocityOverride()

RecordData(IChronicler)

Records the current instance state to the provided chronicler.

public void RecordData(IChronicler chronicler)

Parameters

chronicler IChronicler

The active chronicler pass.