Struct TnuaBuiltinJumpConfig 

pub struct TnuaBuiltinJumpConfig {
    pub height: Float,
    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,
    pub horizontal_distance: Float,
    pub disable_force_forward_after_peak: bool,
}

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.

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.

horizontal_distance: Float

When horizontal_displacement is given in the action input, multiply it by this number.

disable_force_forward_after_peak: bool

When force_forward is given in the action input, only enforce it during the first part of the jump (rising up) and once the peak is reached and the character falls down allow its direction to be determined by the basis again.

Trait Implementations

impl Clone for TnuaBuiltinJumpConfig

fn clone(&self) -> TnuaBuiltinJumpConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for TnuaBuiltinJumpConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TnuaBuiltinJumpConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TnuaBuiltinJumpConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.