Struct gdnative::api::AStar

pub struct AStar { /* fields omitted */ }

core class AStar inherits Reference (reference counted).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

The lifetime of this object is automatically managed through reference counting.

Class hierarchy

AStar inherits methods from:

• Reference
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl AStar

pub fn new() -> Ref<AStar, Unique>

Creates a new instance of this object.

This is a reference-counted type. The returned object is automatically managed by Ref.

pub fn add_point(
    &self,
    id: i64,
    position: Vector3D<f32, UnknownUnit>,
    weight_scale: f64
)

pub fn are_points_connected(
    &self,
    id: i64,
    to_id: i64,
    bidirectional: bool
) -> bool

pub fn clear(&self)

pub fn connect_points(&self, id: i64, to_id: i64, bidirectional: bool)

pub fn disconnect_points(&self, id: i64, to_id: i64, bidirectional: bool)

pub fn get_available_point_id(&self) -> i64

pub fn get_closest_point(
    &self,
    to_position: Vector3D<f32, UnknownUnit>,
    include_disabled: bool
) -> i64

pub fn get_closest_position_in_segment(
    &self,
    to_position: Vector3D<f32, UnknownUnit>
) -> Vector3D<f32, UnknownUnit>

pub fn get_id_path(&self, from_id: i64, to_id: i64) -> TypedArray<i32>

pub fn get_point_capacity(&self) -> i64

pub fn get_point_connections(&self, id: i64) -> TypedArray<i32>

pub fn get_point_count(&self) -> i64

pub fn get_point_path(
    &self,
    from_id: i64,
    to_id: i64
) -> TypedArray<Vector3D<f32, UnknownUnit>>

pub fn get_point_position(&self, id: i64) -> Vector3D<f32, UnknownUnit>

pub fn get_point_weight_scale(&self, id: i64) -> f64

pub fn get_points(&self) -> VariantArray<Shared>

pub fn has_point(&self, id: i64) -> bool

pub fn is_point_disabled(&self, id: i64) -> bool

pub fn remove_point(&self, id: i64)

pub fn reserve_space(&self, num_nodes: i64)

pub fn set_point_disabled(&self, id: i64, disabled: bool)

pub fn set_point_position(&self, id: i64, position: Vector3D<f32, UnknownUnit>)

pub fn set_point_weight_scale(&self, id: i64, weight_scale: f64)

Methods from Deref<Target = Reference>

pub fn init_ref(&self) -> bool

Trait Implementations

impl Debug for AStar

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

Formats the value using the given formatter.

impl Deref for AStar

type Target = Reference

The resulting type after dereferencing.

fn deref(&self) -> &Reference

Dereferences the value.

impl DerefMut for AStar

fn deref_mut(&mut self) -> &mut Reference

Mutably dereferences the value.

impl GodotObject for AStar

type RefKind = RefCounted

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for AStar

fn construct() -> Ref<AStar, Unique>

impl SubClass<Object> for AStar

impl SubClass<Reference> for AStar