Struct TnuaBuiltinWalk 

pub struct TnuaBuiltinWalk {
    pub desired_motion: Vector3,
    pub desired_forward: Option<Dir3>,
}

Fields

desired_motion: Vector3

The direction (in the world space) and speed to accelerate to.

Tnua assumes that this vector is orthogonal to the up dierction.

desired_forward: Option<Dir3>

If non-zero, Tnua will rotate the character so that its negative Z will face in that direction.

Tnua assumes that this vector is orthogonal to the up direction.

Trait Implementations

impl Default for TnuaBuiltinWalk

fn default() -> TnuaBuiltinWalk

Returns the “default value” for a type.

impl TnuaBasis for TnuaBuiltinWalk

type Config = TnuaBuiltinWalkConfig

type Memory = TnuaBuiltinWalkMemory

type Sensors<'a> = TnuaBuiltinWalkSensors<'a>

fn apply( &self, config: &Self::Config, memory: &mut Self::Memory, sensors: &Self::Sensors<'_>, ctx: TnuaBasisContext<'_>, motor: &mut TnuaMotor, )

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

fn get_or_create_sensors<'a: 'b, 'b>( up_direction: Dir3, config: &'a Self::Config, memory: &Self::Memory, entities: &'a mut <Self::Sensors<'static> as TnuaSensors<'static>>::Entities, proximity_sensors_query: &'b Query<'_, '_, (&TnuaProximitySensor, Has<TnuaGhostSensor>)>, controller_entity: Entity, commands: &mut Commands<'_, '_>, has_ghost_overwrites: bool, ) -> Option<Self::Sensors<'b>>

This is where the basis initiates its sensors.

fn ghost_sensor_overwrites<'a>( ghost_overwrites: &'a mut <Self::Sensors<'static> as TnuaSensors<'static>>::GhostOverwrites, entities: &<Self::Sensors<'static> as TnuaSensors<'static>>::Entities, ) -> impl Iterator<Item = (&'a mut TnuaGhostOverwrite, Entity)>

Iterate over each ghost overwrite and the sensor entity of the relevant sensor.

impl TnuaBasisWithDisplacement for TnuaBuiltinWalk

fn displacement(access: &TnuaBasisAccess<'_, Self>) -> Option<Vector3>

The displacement of the character from where the basis wants it to be.

impl TnuaBasisWithFloating for TnuaBuiltinWalk

fn float_height(access: &TnuaBasisAccess<'_, Self>) -> Float

The height the basis is configured to float at, measured from the ground to the center of the character collider.

impl TnuaBasisWithFrameOfReferenceSurface for TnuaBuiltinWalk

fn effective_velocity(access: &TnuaBasisAccess<'_, Self>) -> Vector3

The velocity of the character, relative the what the basis considers its frame of reference.

fn vertical_velocity(access: &TnuaBasisAccess<'_, Self>) -> Float

The vertical velocity the character requires to stay the same height if it wants to move in effective_velocity.

impl TnuaBasisWithGround for TnuaBuiltinWalk

fn is_airborne(access: &TnuaBasisAccess<'_, Self>) -> bool

Can be queried by an action to determine if the character should be considered “in the air”.

fn violate_coyote_time(memory: &mut Self::Memory)

If the basis is at coyote time - finish the coyote time.

fn ground_sensor<'a>(sensors: &Self::Sensors<'a>) -> &'a TnuaProximitySensor

The sensor used to detect the ground.

impl TnuaBasisWithHeadroom for TnuaBuiltinWalk

fn headroom_intrusion<'a>( access: &TnuaBasisAccess<'_, Self>, sensors: &Self::Sensors<'a>, ) -> Option<Range<Float>>

The headroom sensor has detected a ceiling above the character’s head.

fn set_extra_headroom(memory: &mut Self::Memory, extra_headroom: Float)

Increase the range of the headroom sensor.

impl TnuaBasisWithSpring for TnuaBuiltinWalk

fn spring_force( access: &TnuaBasisAccess<'_, Self>, ctx: &TnuaBasisContext<'_>, spring_offset: Float, ) -> TnuaVelChange

Calculate the vertical spring force that this basis would need to apply assuming its vertical distance from the vertical distance it needs to be at equals the spring_offset argument.