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.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have [Component<Mutability = Mutable>], while immutable components will instead have [Component<Mutability = Immutable>].

fn register_required_components( requiree: ComponentId, components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, inheritance_depth: u16, recursion_check_stack: &mut Vec<ComponentId>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn register_component_hooks(hooks: &mut ComponentHooks)

👎Deprecated since 0.16.0: Use the individual hook methods instead (e.g., Component::on_add, etc.)

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

fn on_add() -> Option<for<'w> fn(_: DeferredWorld<'w>, _: HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(_: DeferredWorld<'w>, _: HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_replace() -> Option<for<'w> fn(_: DeferredWorld<'w>, _: HookContext)>

Gets the on_replace ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(_: DeferredWorld<'w>, _: HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(_: DeferredWorld<'w>, _: HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Default for TnuaSimpleFallThroughPlatformsHelper

fn default() -> TnuaSimpleFallThroughPlatformsHelper

Returns the “default value” for a type.