Struct oxygengine_navigation::component::NavAgent

pub struct NavAgent {
    pub position: NavVec3,
    pub direction: NavVec3,
    pub speed: Scalar,
    pub radius: Scalar,
    pub min_target_distance: Scalar,
    // some fields omitted
}

Nav agent component.

Fields

position: NavVec3

Current agent position in world space.

direction: NavVec3

Current agent normalized direction.

speed: Scalar

Current speed (units per second).

radius: Scalar

Agent sphere radius (used in obstacle and agent avoidance).

min_target_distance: Scalar

Mnimal distance to target (affects direction, tells how far look for point to go to in an instant).

Methods

impl NavAgent

pub fn new(position: NavVec3) -> Self

pub fn new_with_direction(position: NavVec3, direction: NavVec3) -> Self

pub fn id(&self) -> NavAgentID

pub fn target(&self) -> Option<NavAgentTarget>

pub fn destination(&self) -> Option<&NavAgentDestination>

pub fn set_destination(
    &mut self,
    target: NavAgentTarget,
    query: NavQuery,
    mode: NavPathMode,
    mesh: NavMeshID
)

Sets destination to go to.

Arguments

• target - target to go to.
• query - query quality.
• mode - path finding quality.
• mesh - nav mesh to move on.

pub fn clear_path(&mut self)

pub fn recalculate_path(&mut self)

pub fn path(&self) -> Option<&[NavVec3]>

pub fn set_path(&mut self, path: Vec<NavVec3>)

Trait Implementations

impl Clone for NavAgent

fn clone(&self) -> NavAgent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for NavAgent

fn default() -> Self

Returns the "default value" for a type.

impl Debug for NavAgent

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

Formats the value using the given formatter.

impl Component for NavAgent

type Storage = VecStorage<Self>

Associated storage type for this component.