Struct CharacterControllerComponent 

pub struct CharacterControllerComponent {

    pub config: CharacterControllerConfig,
    pub grounded: bool,
    pub velocity: Matrix<f32, Const<3>, Const<1>, ArrayStorage<f32, 3, 1>>,
    pub shape: ColliderShape,
    pub max_speed: f32,
    pub acceleration: f32,
    pub jump_impulse: f32,
    pub can_jump: bool,
    pub is_crouching: bool,
    pub is_sprinting: bool,
    pub crouch_enabled: bool,
    pub crouch_speed_multiplier: f32,
    pub sprint_speed_multiplier: f32,
    pub standing_half_height: f32,
    pub crouching_half_height: f32,
    pub crouch_input_was_pressed: bool,
    pub sprint_input_was_pressed: bool,
    pub jump_input_was_pressed: bool,
    pub scale: f32,
    pub friction_rate: f32,
    pub above_max_friction_rate: f32,
    pub engine_input_enabled: bool,
    pub disable_gravity: bool,
    pub external_movement: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>,
    pub external_jump: bool,
}

First-person character controller with kinematic movement.

Provides walking, jumping, crouching, and sprinting using Rapier’s kinematic character controller. Handles ground detection, slope limits, step climbing, and collision response.

Fields

config: CharacterControllerConfig

Configuration for step height, slope limits, and autostep behavior.

grounded: bool

Whether the character is currently touching the ground.

velocity: Matrix<f32, Const<3>, Const<1>, ArrayStorage<f32, 3, 1>>

Current movement velocity.

shape: ColliderShape

Collision shape (typically a capsule).

max_speed: f32

Maximum horizontal movement speed.

acceleration: f32

Acceleration rate when moving.

jump_impulse: f32

Upward velocity applied when jumping.

can_jump: bool

Whether the character can currently jump (grounded and not recently jumped).

is_crouching: bool

Whether the character is currently crouching.

is_sprinting: bool

Whether the character is currently sprinting.

crouch_enabled: bool

Whether crouching is enabled.

crouch_speed_multiplier: f32

Speed multiplier when crouching (typically < 1.0).

sprint_speed_multiplier: f32

Speed multiplier when sprinting (typically > 1.0).

standing_half_height: f32

Capsule half-height when standing.

crouching_half_height: f32

Capsule half-height when crouching.

crouch_input_was_pressed: bool

Internal state for crouch toggle detection.

sprint_input_was_pressed: bool

Internal state for sprint toggle detection.

jump_input_was_pressed: bool

Internal state for jump detection.

scale: f32

Overall character scale factor.

friction_rate: f32

Friction rate applied when grounded and at or below max_speed. Higher values = faster deceleration. Applied as 1.0 - (rate * dt).

above_max_friction_rate: f32

Friction rate applied when grounded and above max_speed. Applied as exponential decay exp(-rate * dt).

engine_input_enabled: bool

When false, the engine skips sprint/crouch/jump input for this entity. The game is responsible for setting is_crouching, is_sprinting, and velocity.y. The engine still handles WASD movement, acceleration, friction, gravity, and collision.

disable_gravity: bool

When true, the engine skips gravity integration and the rapier character solver for this entity, letting game code teleport the player’s transform without physics fighting it. Used by the noclip fly path.

external_movement: Matrix<f32, Const<2>, Const<1>, ArrayStorage<f32, 2, 1>>

Camera-relative analog movement injected by game code, treated like a gamepad left stick: x steers right, y drives forward, magnitude clamped to one. Non-zero values override keyboard movement for the frame, which is how an on-screen joystick moves the player.

external_jump: bool

A one-shot jump request from game code, consumed by the input system on the next step. Lets an on-screen button jump without a Space key.

Implementations

impl CharacterControllerComponent

pub fn new_capsule( half_height: f32, radius: f32, ) -> CharacterControllerComponent

Creates a character controller with a capsule collision shape.

Trait Implementations

impl Clone for CharacterControllerComponent

fn clone(&self) -> CharacterControllerComponent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CharacterControllerComponent

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

Formats the value using the given formatter.

impl Default for CharacterControllerComponent

fn default() -> CharacterControllerComponent

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CharacterControllerComponent

fn deserialize<__D>( __deserializer: __D, ) -> Result<CharacterControllerComponent, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&CharacterControllerComponent> for SceneCharacterController

fn from(controller: &CharacterControllerComponent) -> SceneCharacterController

Converts to this type from the input type.

impl PartialEq for CharacterControllerComponent

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

Equality operator ==.

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

Inequality operator !=.

impl Schema for CharacterControllerComponent

fn schema() -> Value

impl Serialize for CharacterControllerComponent

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CharacterControllerComponent