Struct TnuaBuiltinDash

pub struct TnuaBuiltinDash {
    pub displacement: Vector3,
    pub desired_forward: Option<Dir3>,
    pub allow_in_air: bool,
    pub speed: Float,
    pub brake_to_speed: Float,
    pub acceleration: Float,
    pub brake_acceleration: Float,
    pub input_buffer_time: Float,
}

The basic dash action.

Fields

displacement: Vector3

The direction and distance of the dash.

This input parameter is cached when the action starts. This means that the control system does not have to make sure the direction reamins the same even if the player changes it mid-dash.

desired_forward: Option<Dir3>

Point the negative Z axis of the characetr model in that direction during the dash.

This input parameter is cached when the action starts. This means that the control system does not have to make sure the direction reamins the same even if the player changes it mid-dash.

allow_in_air: bool

Allow this action to start even if the character is not touching ground nor in coyote time.

speed: Float

The speed the character will move in during the dash.

brake_to_speed: Float

After the dash, the character will brake until its speed is below that number.

acceleration: Float

The maximum acceleration when starting the jump.

brake_acceleration: Float

The maximum acceleration when braking after the jump.

Irrelevant if brake_to_speed is set to infinity.

input_buffer_time: Float

A duration, in seconds, where a player can press a dash button before a dash becomes possible (typically when a character is still in the air and about the land) and the dash action would still get registered and be executed once the dash is possible.

Trait Implementations

impl Clone for TnuaBuiltinDash

fn clone(&self) -> TnuaBuiltinDash

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TnuaBuiltinDash

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TnuaBuiltinDash

fn default() -> Self

Returns the “default value” for a type.

impl TnuaAction for TnuaBuiltinDash

const NAME: &'static str = "TnuaBuiltinStraightDash"

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 = TnuaBuiltinDashState

Data that the action can persist between frames.

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

Decides whether the action can start.

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 proximity_sensor_cast_range(&self) -> Float

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