Struct TnuaBuiltinClimb

pub struct TnuaBuiltinClimb {
    pub climbable_entity: Option<Entity>,
    pub anchor: Vector3,
    pub desired_vec_to_anchor: Vector3,
    pub anchor_speed: Float,
    pub anchor_acceleration: Float,
    pub desired_climb_velocity: Vector3,
    pub climb_acceleration: Float,
    pub coyote_time: Float,
    pub desired_forward: Option<Dir3>,
    pub hard_stop_up: Option<Vector3>,
    pub hard_stop_down: Option<Vector3>,
    pub initiation_direction: Vector3,
}

An action for climbing on things.

Fields

climbable_entity: Option<Entity>

The entity being climbed on.

anchor: Vector3

A point on the climbed entity where the character touches it.

Note that this does not actually have to be on any actual collider. It can be a point in the middle of the air, and the action will cause the character to pretend there is something there and climb on it.

desired_vec_to_anchor: Vector3

The position of the anchor compared to the character.

The action will try to maintain this horizontal relative position.

anchor_speed: Float

Speed for maintaining desired_vec_to_anchor.

anchor_acceleration: Float

Acceleration for maintaining desired_vec_to_anchor.

desired_climb_velocity: Vector3

The velocity to climb at (move up/down the entity)

climb_acceleration: Float

The acceleration to climb at.

coyote_time: Float

The time, in seconds, the character can still jump after letting go.

desired_forward: Option<Dir3>

Force the character to face in a particular direction.

hard_stop_up: Option<Vector3>

Prevent the character from climbing above this point.

Tip: use probe_extent_from_closest_point to find this point.

hard_stop_down: Option<Vector3>

Prevent the character from climbing below this point.

Tip: use probe_extent_from_closest_point to find this point.

initiation_direction: Vector3

The direction used to initiate the climb.

This field is not used by the action itself. It’s purpose is to help user controller systems determine if the player input is a continuation of the motion used to initiate the climb, or if it’s a motion for breaking from the climb.

Trait Implementations

impl Clone for TnuaBuiltinClimb

fn clone(&self) -> TnuaBuiltinClimb

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for TnuaBuiltinClimb

fn default() -> Self

Returns the “default value” for a type.

impl TnuaAction for TnuaBuiltinClimb

const NAME: &'static str = "TnuaBuiltinClimb"

The default name of the action.

const VIOLATES_COYOTE_TIME: bool = true

Set this to true for actions that may launch the character into the air.

type State = TnuaBuiltinClimbState

Data that the action can persist between frames.

fn apply( &self, state: &mut Self::State, ctx: TnuaActionContext<'_>, lifecycle_status: TnuaActionLifecycleStatus, motor: &mut TnuaMotor, ) -> TnuaActionLifecycleDirective

This is where the action affects the character’s motion.

fn initiation_decision( &self, _ctx: TnuaActionContext<'_>, _being_fed_for: &Stopwatch, ) -> TnuaActionInitiationDirective

Decides whether the action can start.

fn target_entity(&self, _state: &Self::State) -> Option<Entity>

If the action targets an entity, return that entity

fn proximity_sensor_cast_range(&self) -> Float

A value to configure the range of the ground proximity sensor according to the action’s needs.