Struct CharacterController
pub struct CharacterController {
pub config: CharacterConfig,
pub state: CharacterState,
}Expand description
Zero-heap kinematic character controller.
Fields§
§config: CharacterConfig§state: CharacterStateImplementations§
§impl CharacterController
impl CharacterController
pub const fn new(
config: CharacterConfig,
start_position: [f32; 3],
) -> 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,
)
pub fn step<F>( &mut self, wish_dir: [f32; 2], sprint: bool, jump: bool, crouch: bool, dt: f32, ground_probe: F, )
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 elevationyand normal[nx, ny, nz]at(x, z).
pub fn eye_position(&self) -> [f32; 3]
pub fn eye_position(&self) -> [f32; 3]
Computes eye position in world space (for camera placement).
§impl CharacterController
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]]>,
)
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
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>
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>
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
SubmersionStatetransition
Trait Implementations§
§impl Clone for CharacterController
impl Clone for CharacterController
§fn clone(&self) -> 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)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreimpl Copy for CharacterController
Auto Trait Implementations§
impl Freeze for CharacterController
impl RefUnwindSafe for CharacterController
impl Send for CharacterController
impl Sync for CharacterController
impl Unpin for CharacterController
impl UnsafeUnpin for CharacterController
impl UnwindSafe for CharacterController
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more