Skip to main content

CharacterState

Struct CharacterState 

#[repr(C)]
pub struct CharacterState { pub position: [f32; 3], pub velocity: [f32; 3], pub yaw: f32, pub pitch: f32, pub is_grounded: bool, pub is_crouching: bool, pub ground_normal: [f32; 3], pub platform_velocity: [f32; 3], pub stride_distance: f32, pub submersion: SubmersionState, pub water_depth: f32, pub wetness: f32, }
Expand description

Dynamic runtime state of the character.

Fields§

§position: [f32; 3]

3D position [x, y, z] in world meters (at the base/feet of the capsule).

§velocity: [f32; 3]

3D velocity [vx, vy, vz] in m/s.

§yaw: f32

Facing yaw in radians.

§pitch: f32

Pitch angle in radians (for head/look).

§is_grounded: bool

True if the character’s feet are currently contacting traversable ground.

§is_crouching: bool

True if the character is currently crouching.

§ground_normal: [f32; 3]

Surface normal vector [nx, ny, nz] of the contacted ground.

§platform_velocity: [f32; 3]

Moving platform velocity [vx, vy, vz] imparted to the character.

§stride_distance: f32

Accumulated walking distance in meters (drives footstep sounds & head bob).

§submersion: SubmersionState

Fluid submersion locomotion state.

§water_depth: f32

Water depth at character feet in meters.

§wetness: f32

Dynamic surface wetness ratio in [0.0, 1.0].

Trait Implementations§

§

impl Clone for CharacterState

§

fn clone(&self) -> CharacterState

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 CharacterState

§

impl Debug for CharacterState

§

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

Formats the value using the given formatter. Read more
§

impl Default for CharacterState

§

fn default() -> CharacterState

Returns the “default value” for a type. Read more
§

impl PartialEq for CharacterState

§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
§

impl StructuralPartialEq for CharacterState

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,