Struct oxygengine_navigation::component::NavAgent[−][src]

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

Expand description

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).

Implementations

impl NavAgent[src]

pub fn new(position: NavVec3) -> Self[src]

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

pub fn id(&self) -> NavAgentId[src]

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

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

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

[src]

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)[src]

pub fn recalculate_path(&mut self)[src]

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

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

Trait Implementations

impl Clone for NavAgent[src]

fn clone(&self) -> NavAgent[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0 [src]

Performs copy-assignment from source. Read more

impl Component for NavAgent[src]

type Storage = VecStorage<Self>

Associated storage type for this component.

impl Debug for NavAgent[src]

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

Formats the value using the given formatter. Read more

impl Default for NavAgent[src]

fn default() -> Self[src]

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

impl<'de> Deserialize<'de> for NavAgent[src]

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

[src]

Deserialize this value from the given Serde deserializer. Read more

impl Prefab for NavAgent[src]

fn from_prefab(data: Value) -> Result<Self, PrefabError>[src]

fn from_prefab_with_extras(
    data: Value, 
    _named_entities: &HashMap<String, Entity, RandomState>, 
    _state_token: ID<()>
) -> Result<Self, PrefabError>

[src]

fn to_prefab(&self) -> Result<Value, PrefabError>[src]

fn from_prefab_str(data: &str) -> Result<Self, PrefabError>[src]

fn to_prefab_string(&self) -> Result<String, PrefabError>[src]

fn post_from_prefab(&mut self)[src]

impl Serialize for NavAgent[src]

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer,

[src]

Serialize this value into the given Serde serializer. Read more

impl PrefabComponent for NavAgent[src]

Auto Trait Implementations

impl RefUnwindSafe for NavAgent

impl Send for NavAgent

impl Sync for NavAgent

impl Unpin for NavAgent

impl UnwindSafe for NavAgent

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Any for T where
    T: Any,

pub fn get_type_id(&self) -> TypeId

impl<T> Borrow<T> for T where
    T: ?Sized,

[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<'a, C> ComponentContainerModify<'a, ComponentContainer<'a, C>> for C where
    C: Component,

[src]

pub fn fetch(world: &'a World, entity: Entity) -> ComponentContainer<'a, C>[src]

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>,

[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<SS, SP> SupersetOf<SS> for SP where
    SS: SubsetOf<SP>,

pub fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more

pub fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).

pub unsafe fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.

pub fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.

impl<T> ToOwned for T where
    T: Clone,

[src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> TryDefault for T where
    T: Default,

pub fn try_default() -> Result<T, String>

Tries to create the default.

fn unwrap_default() -> Self

Calls try_default and panics on an error case.

impl<T, U> TryFrom<U> for T where
    U: Into<T>,

[src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>,

[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.

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

[src]

impl<T> Event for T where
    T: Send + Sync + 'static,

impl<T> Resource for T where
    T: Any,