Struct TnuaSimpleFallThroughPlatformsHelper

pub struct TnuaSimpleFallThroughPlatformsHelper { /* private fields */ }

Helper component for implementing fall-through platforms.

See https://github.com/idanarye/bevy-tnua/wiki/Jump-fall-Through-Platforms

Place this component on the characetr entity (the one that has the TnuaProximitySensor and the TnuaGhostSensor) and inside a system that runs in TnuaUserControlsSystemSet (typically the player controls system) use with and call one of the methods of the returned handle object every frame. See the description of these methods to determine which one to call.

Implementations

impl TnuaSimpleFallThroughPlatformsHelper

pub fn with<'a>( &'a mut self, proximity_sensor: &'a mut TnuaProximitySensor, ghost_sensor: &'a TnuaGhostSensor, min_proximity: Float, ) -> TnuaHandleForSimpleFallThroughPlatformsHelper<'a>

Get an handle for operating the helper.

The min_proximity argument is the minimal distance from the origin of the cast ray/shape (usually the center of the character) to the platform. If the distance to the platform is below that, the helper will assume that the character only jumped halfway through it, not high enough to stand on it.

Trait Implementations

impl Component for TnuaSimpleFallThroughPlatformsHelper

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy::ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

fn register_required_components( requiree: ComponentId, components: &mut Components, storages: &mut Storages, required_components: &mut RequiredComponents, inheritance_depth: u16, )

Registers required components.

fn register_component_hooks(hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.

impl Default for TnuaSimpleFallThroughPlatformsHelper

fn default() -> TnuaSimpleFallThroughPlatformsHelper

Returns the “default value” for a type.