Skip to main content

FollowController

Struct FollowController 

Source
pub struct FollowController {
    pub target: Option<SkinnedMeshHandle>,
    pub distance: f32,
    pub height: f32,
    pub drive: FollowDrive,
    pub turn_speed: f32,
    pub speed_parameter: String,
    pub jump_height: f32,
}
Expand description

Third-person follow settings carried on a CameraController.

When follow is set the camera becomes a third-person orbit camera: the mouse orbits around the followed character, and WASD steers the character itself (camera-relative). The character must be a SkinnedMesh with a capsule, so it has a kinematic character capsule to move.

Fields§

§target: Option<SkinnedMeshHandle>

Name of the followed SkinnedMesh. It must declare a capsule.

§distance: f32

Orbit distance from the pivot to the camera, in world units.

§height: f32

Pivot height above the character’s feet, in world units.

§drive: FollowDrive

How the character moves; see FollowDrive.

§turn_speed: f32

Character turn rate toward the input heading, in radians per second.

§speed_parameter: String

Name of the character’s AnimationGraph float parameter that receives the current travel speed in world units per second (drives a locomotion blendspace). Empty disables parameter writes, leaving the graph externally driven.

§jump_height: f32

Jump apex height in world units when the jump key is pressed while grounded. 0 disables jumping.

Trait Implementations§

Source§

impl Clone for FollowController

Source§

fn clone(&self) -> FollowController

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
Source§

impl Debug for FollowController

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FollowController

Source§

fn default() -> FollowController

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

impl<'de> Deserialize<'de> for FollowController

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for FollowController

Source§

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. 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
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
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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.

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, <T as TryFrom<U>>::Error>

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.