Struct TnuaBuiltinJump

pub struct TnuaBuiltinJump {
    pub height: Float,
    pub allow_in_air: bool,
    pub upslope_extra_gravity: Float,
    pub takeoff_extra_gravity: Float,
    pub takeoff_above_velocity: Float,
    pub fall_extra_gravity: Float,
    pub shorten_extra_gravity: Float,
    pub peak_prevention_at_upward_velocity: Float,
    pub peak_prevention_extra_gravity: Float,
    pub reschedule_cooldown: Option<Float>,
    pub input_buffer_time: Float,
}

The basic jump action.

This action implements jump physics explained in https://youtu.be/hG9SzQxaCm8 and https://youtu.be/eeLPL3Y9jjA. Most of its fields have sane defaults - the only field that must be set is height, which controls the jump height.

The action must be fed for as long as the player holds the jump button. Once the action stops being fed, it’ll apply extra gravity to shorten the jump. If the game desires fixed height jumps instead (where the player cannot make lower jumps by tapping the jump button) shorten_extra_gravity should be set to 0.0.

Fields

height: Float

The height the character will jump to.

If shorten_extra_gravity is higher than 0.0, the character may stop the jump in the middle if the jump action is no longer fed (usually when the player releases the jump button) and the character may not reach its full jump height.

The jump height is calculated from the center of the character at float_height to the center of the character at the top of the jump. It does not mean the height from the ground. The float height is calculated by the inspecting the character’s current position and the basis’ displacement.

allow_in_air: bool

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

upslope_extra_gravity: Float

Extra gravity for breaking too fast jump from running up a slope.

When running up a slope, the character gets more jump strength to avoid slamming into the slope. This may cause the jump to be too high, so this value is used to brake it.

NOTE: This force will be added to the normal gravity.

takeoff_extra_gravity: Float

Extra gravity for fast takeoff.

Without this, jumps feel painfully slow. Adding this will apply extra gravity until the vertical velocity reaches below takeoff_above_velocity, and increase the initial jump boost in order to compensate. This will make the jump feel more snappy.

takeoff_above_velocity: Float

The range of upward velocity during takeoff_extra_gravity is applied.

To disable, set this to Float::INFINITY rather than zero.

fall_extra_gravity: Float

Extra gravity for falling down after reaching the top of the jump.

NOTE: This force will be added to the normal gravity.

shorten_extra_gravity: Float

Extra gravity for shortening a jump when the player releases the jump button.

NOTE: This force will be added to the normal gravity.

peak_prevention_at_upward_velocity: Float

Used to decrease the time the character spends “floating” at the peak of the jump.

When the character’s upward velocity is above this value, peak_prevention_extra_gravity will be added to the gravity in order to shorten the float time.

This extra gravity is taken into account when calculating the initial jump speed, so the character is still supposed to reach its full jump height.

peak_prevention_extra_gravity: Float

Extra gravity for decreasing the time the character spends at the peak of the jump.

NOTE: This force will be added to the normal gravity.

reschedule_cooldown: Option<Float>

A duration, in seconds, after which the character would jump if the jump button was already pressed when the jump became available.

The duration is measured from the moment the jump became available - not from the moment the jump button was pressed.

When set to None, the character will not jump no matter how long the player holds the jump button.

If the jump button is held but the jump input is still buffered (see input_buffer_time), this setting will have no effect because the character will simply jump immediately.

input_buffer_time: Float

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

Trait Implementations

impl Clone for TnuaBuiltinJump

fn clone(&self) -> TnuaBuiltinJump

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TnuaBuiltinJump

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

Formats the value using the given formatter.

impl Default for TnuaBuiltinJump

fn default() -> Self

Returns the “default value” for a type.

impl TnuaAction for TnuaBuiltinJump

const NAME: &'static str = "TnuaBuiltinJump"

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

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.