Struct KinematicCharacterControllerOutput

pub struct KinematicCharacterControllerOutput {
    pub grounded: bool,
    pub desired_translation: Vect,
    pub effective_translation: Vect,
    pub collisions: Vec<CharacterCollision>,
    pub is_sliding_down_slope: bool,
}

The output of a character control.

This component is automatically added after the first execution of a character control based on the KinematicCharacterController component with its KinematicCharacterController::translation set to a value other than None.

Fields

grounded: bool

Indicates whether the shape is grounded after its kinematic movement.

desired_translation: Vect

The initial desired movement of the character if there were no obstacle.

effective_translation: Vect

The translation calculated by the last character control step taking obstacles into account.

collisions: Vec<CharacterCollision>

Collisions between the character and obstacles found in its path.

is_sliding_down_slope: bool

Indicates whether the shape is sliding down a slope after its kinematic movement.

Trait Implementations

impl Clone for KinematicCharacterControllerOutput

fn clone(&self) -> KinematicCharacterControllerOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for KinematicCharacterControllerOutput

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

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

Formats the value using the given formatter.

impl Default for KinematicCharacterControllerOutput

fn default() -> KinematicCharacterControllerOutput

Returns the “default value” for a type.

impl PartialEq for KinematicCharacterControllerOutput

fn eq(&self, other: &KinematicCharacterControllerOutput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for KinematicCharacterControllerOutput