Struct KinematicCharacterController 

pub struct KinematicCharacterController {

    pub translation: Option<Vect>,
    pub custom_shape: Option<(Collider, Vect, Rot)>,
    pub custom_mass: Option<Real>,
    pub up: Vect,
    pub offset: CharacterLength,
    pub slide: bool,
    pub autostep: Option<CharacterAutostep>,
    pub max_slope_climb_angle: Real,
    pub min_slope_slide_angle: Real,
    pub apply_impulse_to_dynamic_bodies: bool,
    pub snap_to_ground: Option<CharacterLength>,
    pub filter_flags: QueryFilterFlags,
    pub filter_groups: Option<CollisionGroups>,
    pub normal_nudge_factor: Real,
}

A character controller for kinematic bodies and free-standing colliders.

Fields

translation: Option<Vect>

The translations we desire the character to move by if it doesn’t meet any obstacle.

custom_shape: Option<(Collider, Vect, Rot)>

The shape, and its position, to be used instead of the shape of the collider attached to the same entity is this KinematicCharacterController.

custom_mass: Option<Real>

The mass to be used for impulse of dynamic bodies. This replaces the mass of the rigid-body potentially associated to the collider attached to the same entity as this KinematicCharacterController.

This field isn’t used if Self::apply_impulse_to_dynamic_bodies is set to false.

up: Vect

The direction that goes “up”. Used to determine where the floor is, and the floor’s angle.

offset: CharacterLength

A small gap to preserve between the character and its surroundings.

This value should not be too large to avoid visual artifacts, but shouldn’t be too small (must not be zero) to improve numerical stability of the character controller.

slide: bool

Should the character try to slide against the floor if it hits it?

autostep: Option<CharacterAutostep>

Should the character automatically step over small obstacles?

max_slope_climb_angle: Real

The maximum angle (radians) between the floor’s normal and the up vector that the character is able to climb.

min_slope_slide_angle: Real

The minimum angle (radians) between the floor’s normal and the up vector before the character starts to slide down automatically.

apply_impulse_to_dynamic_bodies: bool

Should the character apply forces to dynamic bodies in its path?

snap_to_ground: Option<CharacterLength>

Should the character be automatically snapped to the ground if the distance between the ground and its feet are smaller than the specified threshold?

filter_flags: QueryFilterFlags

Flags for filtering-out some categories of entities from the environment seen by the character controller.

filter_groups: Option<CollisionGroups>

Groups for filtering-out some colliders from the environment seen by the character controller.

normal_nudge_factor: Real

Increase this number if your character appears to get stuck when sliding against surfaces.

This is a small distance applied to the movement toward the contact normals of shapes hit by the character controller. This helps shape-casting not getting stuck in an always-penetrating state during the sliding calculation.

This value should remain fairly small since it can introduce artificial “bumps” when sliding along a flat surface.

Trait Implementations

impl Clone for KinematicCharacterController

fn clone(&self) -> KinematicCharacterController

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for KinematicCharacterController

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, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

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 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 Debug for KinematicCharacterController

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

Formats the value using the given formatter.

impl Default for KinematicCharacterController

fn default() -> Self

Returns the “default value” for a type.