Struct TnuaCrouchEnforcer

pub struct TnuaCrouchEnforcer { /* private fields */ }

Prevents the character from standing up if the player stops feeding a crouch action (like TnuaBuiltinCrouch) while under an obstacle.

This will create a child entity with a proximity sensor pointed upward. When that sensor senses a ceiling, it will force feed the action even if it is no longer fed by the game code into the controller (which would happen if the player releases the crouch button)

Using it requires three things:

1. Adding the plugin TnuaCrouchEnforcerPlugin.
2. Adding TnuaCrouchEnforcer as a component to the character entity.
3. Passing the crouch action through the component’s enforcing method:

   controller.action(crouch_enforcer.enforcing(TnuaBuiltinCrouch {
       float_offset: -0.9,
       ..Default::default()
   }));

Implementations

impl TnuaCrouchEnforcer

pub fn new( offset: Vector3, modify_sensor: impl 'static + Send + Sync + Fn(&mut EntityCommands<'_>), ) -> Self

Create a new crouch enforcer, to be added as a component to the entity that the crouch action will be fed to.

Arguments:

• offset - the origin of the proximity sensor used to determine if the character needs to crouch. Should be placed at the top of the collider. The sensor is always pointed upwards.
• modify_sensor - a function called with the command that creates the sensor. This function has the opportunity to add things to the sensor entity - mostly cast-shape components.

pub fn enforcing<A: TnuaCrouchEnforcedAction>(&mut self, crouch_action: A) -> A

Trait Implementations

impl Component for TnuaCrouchEnforcer

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]