Skip to main content

CharacterController

Struct CharacterController 

pub struct CharacterController {
    pub config: CharacterConfig,
    pub state: CharacterState,
}
Expand description

Zero-heap kinematic character controller.

Fields§

§config: CharacterConfig§state: CharacterState

Implementations§

§

impl CharacterController

pub const fn new( config: CharacterConfig, start_position: [f32; 3], ) -> CharacterController

Creates a new character controller with the given configuration and starting position.

pub fn step<F>( &mut self, wish_dir: [f32; 2], sprint: bool, jump: bool, crouch: bool, dt: f32, ground_probe: F, )
where F: Fn(f32, f32) -> (f32, [f32; 3]),

Advances the character simulation by one fixed timestep $\Delta t$.

  • wish_dir: Normalized 2D horizontal input direction [forward, strafe_right].
  • sprint: True if sprinting.
  • jump: True if jump requested on this tick.
  • crouch: True if crouch requested.
  • ground_probe: Terrain or mesh ground probe returning elevation y and normal [nx, ny, nz] at (x, z).

pub fn eye_position(&self) -> [f32; 3]

Computes eye position in world space (for camera placement).

§

impl CharacterController

pub fn step_character_3d<const MAX_LEAVES: usize>( &mut self, wish_dir: [f32; 2], sprint: bool, jump: bool, crouch: bool, dt: f32, bvh: &BroadphaseBvh<MAX_LEAVES>, shapes: &[ColliderShape3D], motors: &[Motor], body_velocities: Option<&[[f32; 3]]>, )

Advances the character controller in full 3D space against a BroadphaseBvh and 3D collider shapes (SdfAnalytical, Cuboid, Sphere, Capsule, ConvexHull):

  • 3D capsule sweep (cast_capsule) with iterative slide-and-collide plane projection,
  • Stair auto-stepping up to config.max_step_height,
  • Ceiling / overhang downward velocity clamping on upward head impact,
  • Moving platform velocity inheritance from contacted kinematic/dynamic bodies.
§

impl CharacterController

pub fn step_with_water<F, W>( &mut self, wish_dir: [f32; 2], sprint: bool, jump: bool, crouch: bool, dt: f32, ground_probe: F, water_probe: W, ) -> Option<SubmersionState>
where F: Fn(f32, f32) -> (f32, [f32; 3]), W: Fn(f32, f32) -> f32,

Advances the character simulation with two-way fluid coupling:

  • Evaluates water surface at feet
  • Applies wading drag and swim locomotion
  • Computes Archimedes buoyancy lifting the character in deep water
  • Updates dynamic wetness and returns any new SubmersionState transition

Trait Implementations§

§

impl Clone for CharacterController

§

fn clone(&self) -> CharacterController

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
§

impl Copy for CharacterController

§

impl Debug for CharacterController

§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

impl<T> WasmNotSync for T
where T: Sync,