Struct NavmeshAgent

pub struct NavmeshAgent { /* private fields */ }

Navmesh agent is a “pathfinding unit” that performs navigation on a mesh. It is designed to cover most of simple use cases when you need to build and follow some path from point A to point B.

Implementations

impl NavmeshAgent

pub fn new() -> Self

Creates new navigation mesh agent.

pub fn position(&self) -> Vector3<f32>

Returns agent’s position.

pub fn path(&self) -> &[Vector3<f32>]

Returns agent’s path that will be followed.

pub fn set_speed(&mut self, speed: f32)

Sets new speed of agent’s movement.

pub fn speed(&self) -> f32

Returns current agent’s movement speed.

pub fn set_threshold(&mut self, threshold: f32)

Sets a new path recalculation threshold (in meters). The threshold is used to prevent path recalculation in case if a target’s position or the agent position haven’t significantly moved. This significance is defined by the threshold.

pub fn threshold(&self) -> f32

Returns the current path recalculation threshold (in meters). See Self::set_threshold for more info.

pub fn set_radius(&mut self, radius: f32)

Sets a new radius for the navmesh agent. The agent will use this radius to walk around corners with the distance equal to the radius. This could help to prevent the agent from being stuck in the corners. The default value is 0.2 meters.

pub fn radius(&self) -> f32

Returns the current radius of the navmesh agent. See Self::set_radius for more info about radius parameter.

impl NavmeshAgent

pub fn calculate_path( &mut self, navmesh: &Navmesh, src_point: Vector3<f32>, dest_point: Vector3<f32>, ) -> Result<PathKind, PathError>

Calculates path from point A to point B. In most cases there is no need to use this method directly, because update will call it anyway if target position has moved.

pub fn update( &mut self, dt: f32, navmesh: &Navmesh, ) -> Result<PathKind, PathError>

Performs single update tick that moves agent to the target along the path (which is automatically recalculated if target’s position has changed).

pub fn steering_target(&self) -> Option<Vector3<f32>>

Returns current steering target which in most cases next path point from which agent is close to.

pub fn set_target(&mut self, new_target: Vector3<f32>)

Sets new target for the agent.

pub fn target(&self) -> Vector3<f32>

Returns current target of the agent.

pub fn set_position(&mut self, new_position: Vector3<f32>)

Sets new position of the agent.

Trait Implementations

impl Clone for NavmeshAgent

fn clone(&self) -> NavmeshAgent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NavmeshAgent

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

Formats the value using the given formatter.

impl Default for NavmeshAgent

fn default() -> Self

Returns the “default value” for a type.

impl Visit for NavmeshAgent

where Vec<Vector3<f32>>: Visit, u32: Visit, Vector3<f32>: Visit, f32: Visit, bool: Visit,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> VisitResult

Read or write this value, depending on whether Visitor::is_reading() is true or false.