Class ClimbLocomotion

Namespace

Trailblazer.Navigation.Motor

Assembly

Trailblazer.dll

Stores climb locomotion configuration and runtime attachment state.

public class ClimbLocomotion : ILocomotion, ITransient, IRecordable

Inheritance

object

ClimbLocomotion

Implements

ILocomotion

ITransient

IRecordable

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ITransientExtensions.ClearTransientState(ITransient)

ITransientExtensions.SyncTransientState(ITransient, ITransient)

Constructors

ClimbLocomotion()

public ClimbLocomotion()

Fields

AllowLateralTraverse

Whether lateral traverse across a climb surface is allowed.

public bool AllowLateralTraverse

Field Value

bool

CanClimb

Determines whether this locomotion may engage with climb affordances.

public bool CanClimb

Field Value

bool

ClimbResolver

Optional host-owned resolver that supplies deterministic climb affordance snapshots.

public IClimbAffordanceResolver? ClimbResolver

Field Value

IClimbAffordanceResolver

ClimbStartTolerance

Positional tolerance used for initial attach and attachment continuity checks.

public Fixed64 ClimbStartTolerance

Field Value

Fixed64

DefaultClimbStartTolerance

Default positional tolerance used when validating attachment continuity without a stable affordance id.

public static readonly Fixed64 DefaultClimbStartTolerance

Field Value

Fixed64

DefaultGravityCompensationWhileClimbing

Default gravity compensation applied while attached to a climb affordance.

public static readonly Fixed64 DefaultGravityCompensationWhileClimbing

Field Value

Fixed64

DefaultMaxClimbAcceleration

Default maximum acceleration while climbing.

public static readonly Fixed64 DefaultMaxClimbAcceleration

Field Value

Fixed64

DefaultMaxClimbSpeed

Default maximum speed while climbing.

public static readonly Fixed64 DefaultMaxClimbSpeed

Field Value

Fixed64

GravityCompensationWhileClimbing

Amount of gravity canceled while actively climbing.

public Fixed64 GravityCompensationWhileClimbing

Field Value

Fixed64

MaxClimbAcceleration

Maximum acceleration while attached.

public Fixed64 MaxClimbAcceleration

Field Value

Fixed64

MaxClimbSpeed

Maximum climb speed while attached.

public Fixed64 MaxClimbSpeed

Field Value

Fixed64

ValidateActiveMantleWithHost

Whether active mantle should query an optional host validator each frame.

public bool ValidateActiveMantleWithHost

Field Value

bool

Properties

ActiveAllowDescent

Whether descent is allowed for the active frame snapshot.

[Transient]
public bool ActiveAllowDescent { get; set; }

Property Value

bool

ActiveAllowDetachJump

Whether detaching via jump is allowed for the active frame snapshot.

[Transient]
public bool ActiveAllowDetachJump { get; set; }

Property Value

bool

ActiveAllowLateralTraverse

Whether lateral movement is allowed for the active frame snapshot.

[Transient]
public bool ActiveAllowLateralTraverse { get; set; }

Property Value

bool

ActiveAllowMantle

Whether mantling is allowed for the active frame snapshot.

[Transient]
public bool ActiveAllowMantle { get; set; }

Property Value

bool

ActiveClimbKind

Kind of affordance currently attached, when active.

[Transient]
public ClimbAffordanceKind ActiveClimbKind { get; set; }

Property Value

ClimbAffordanceKind

AttachedSurfaceNormal

Stored attachment surface normal for the current climb interaction.

[Transient]
public Vector3d AttachedSurfaceNormal { get; set; }

Property Value

Vector3d

AttachedUpDirection

Stored climb up direction for the current climb interaction.

[Transient]
public Vector3d AttachedUpDirection { get; set; }

Property Value

Vector3d

AttachmentId

Stable host affordance identity when available.

[Transient]
public int? AttachmentId { get; set; }

Property Value

int?

AttachmentPoint

Stored attachment point for the current climb interaction.

[Transient]
public Vector3d AttachmentPoint { get; set; }

Property Value

Vector3d

IsClimbing

Whether active climb movement is currently attached to an affordance.

[Transient]
public bool IsClimbing { get; set; }

Property Value

bool

IsEnabled

Indicates whether this locomotion behavior is enabled. If disabled, its movement effects will not be applied.

public bool IsEnabled { get; set; }

Property Value

bool

IsMantling

Whether the locomotion is currently in a mantle/top-out phase.

[Transient]
public bool IsMantling { get; set; }

Property Value

bool

MantleTargetPosition

Current mantle target when a ledge affordance supplies one.

[Transient]
public Vector3d? MantleTargetPosition { get; set; }

Property Value

Vector3d?

Methods

ApplyClimbSnapshot(ClimbAffordanceSnapshot)

Applies a climb affordance snapshot to update the active attachment state for the current frame.

public void ApplyClimbSnapshot(ClimbAffordanceSnapshot snapshot)

Parameters

snapshot ClimbAffordanceSnapshot

CreateActiveMantleState()

Creates a readonly snapshot for optional active mantle validation.

public ActiveMantleState CreateActiveMantleState()

Returns

ActiveMantleState

RecordData(IChronicler)

Records the current instance state to the provided chronicler.

public void RecordData(IChronicler chronicler)

Parameters

chronicler IChronicler

The active chronicler pass.