Struct TnuaBuiltinClimb 

pub struct TnuaBuiltinClimb {
    pub anchor: Vector3,
    pub desired_vec_to_anchor: Vector3,
    pub desired_climb_motion: Vector3,
    pub desired_forward: Option<Dir3>,
    pub hard_stop_up: Option<Vector3>,
    pub hard_stop_down: Option<Vector3>,
}

An action for climbing on things.

Fields

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.

desired_climb_motion: Vector3

The direction (in the world space) and speed to climb at (move up/down the entity)

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.

Trait Implementations

impl Clone for TnuaBuiltinClimb

fn clone(&self) -> TnuaBuiltinClimb

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for TnuaBuiltinClimb

fn default() -> TnuaBuiltinClimb

Returns the “default value” for a type.

impl<B> TnuaAction<B> for TnuaBuiltinClimb

where B: TnuaBasisWithGround + TnuaBasis,

type Config = TnuaBuiltinClimbConfig

type Memory = TnuaBuiltinClimbMemory

Data that the action can persist between frames.

fn initiation_decision( &self, _config: &Self::Config, _sensors: &B::Sensors<'_>, _ctx: TnuaActionContext<'_, B>, _being_fed_for: &Stopwatch, ) -> TnuaActionInitiationDirective

Decides whether the action can start.

fn apply( &self, config: &Self::Config, memory: &mut Self::Memory, _sensors: &B::Sensors<'_>, ctx: TnuaActionContext<'_, B>, lifecycle_status: TnuaActionLifecycleStatus, motor: &mut TnuaMotor, ) -> TnuaActionLifecycleDirective

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

fn influence_basis( &self, _config: &Self::Config, _memory: &Self::Memory, _ctx: TnuaBasisContext<'_>, _basis_input: &B, _basis_config: &<B as TnuaBasis>::Config, basis_memory: &mut <B as TnuaBasis>::Memory, )

An action can use this method to send information back to the basis’ memory.