Struct ark_api::world::PhysicsCharacter

pub struct PhysicsCharacter { /* private fields */ }

Physics character component

Use to get predictable collisions against the physics world for an entity. Suitable for things like FPS shooter characters and other similar things that are directly controlled by the player and would be impractical to get to behave correctly using real physics.

Puts a capsule around the entity, defined by the height and radius properties, to do collisions. Uses the Velocity component to update the position of the entity and leaves adding gravity to that to the user.

Implementations

impl PhysicsCharacter

pub fn radius(&self) -> ValueAccessorReadWriteAnimate<f32>

Returns a ValueAccessor for the character radius (horizontal plane).

pub fn height(&self) -> ValueAccessorReadWriteAnimate<f32>

Returns a ValueAccessor for the character vertical height.

pub fn up_direction(&self) -> ValueAccessorReadWriteAnimate<Vec3>

Returns a ValueAccessor for the character up direction.

pub fn collision_flags(&self) -> ValueAccessorRead<CharacterCollisionFlags>

Returns a ValueAccessor for the character collision flags.

Use it to see what collisions the last frame resulted in, for instance to reset velocity if ground was hit. Can only be read.

pub fn velocity(&self) -> ValueAccessorReadWriteAnimate<Vec3>

Returns a ValueAccessor for the world linear velocity of the physics character.

Used to set/get/animate the velocity.

Trait Implementations

impl ComponentTrait for PhysicsCharacter

fn get_type() -> ComponentType

The type of the component, as a ComponentType enum.

fn from_entity(handle: Entity) -> Self

Adopt an Entity, wrap in a component struct.

fn entity(&self) -> Entity

Get the entity that the component belongs to.

impl Debug for PhysicsCharacter

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

Formats the value using the given formatter.