Struct AStarGrid2D
#[repr(C)]pub struct AStarGrid2D { /* private fields */ }
Expand description
Godot class AStarGrid2D.
Inherits RefCounted
.
Related symbols:
a_star_grid_2d
: sidecar module with related enum/flag typesIAStarGrid2D
: virtual methods
See also Godot docs for AStarGrid2D
.
§Construction
This class is reference-counted. You can create a new instance using AStarGrid2D::new_gd()
.
Implementations§
§impl AStarGrid2D
impl AStarGrid2D
pub fn set_region(&mut self, region: Rect2i)
pub fn get_region(&self) -> Rect2i
pub fn set_size(&mut self, size: Vector2i)
pub fn get_size(&self) -> Vector2i
pub fn set_offset(&mut self, offset: Vector2)
pub fn get_offset(&self) -> Vector2
pub fn set_cell_size(&mut self, cell_size: Vector2)
pub fn get_cell_size(&self) -> Vector2
pub fn set_cell_shape(&mut self, cell_shape: CellShape)
pub fn get_cell_shape(&self) -> CellShape
pub fn is_in_bounds(&self, x: i32, y: i32) -> bool
pub fn is_in_boundsv(&self, id: Vector2i) -> bool
pub fn is_dirty(&self) -> bool
pub fn update(&mut self)
pub fn set_jumping_enabled(&mut self, enabled: bool)
pub fn is_jumping_enabled(&self) -> bool
pub fn set_diagonal_mode(&mut self, mode: DiagonalMode)
pub fn get_diagonal_mode(&self) -> DiagonalMode
pub fn set_default_compute_heuristic(&mut self, heuristic: Heuristic)
pub fn get_default_compute_heuristic(&self) -> Heuristic
pub fn set_default_estimate_heuristic(&mut self, heuristic: Heuristic)
pub fn get_default_estimate_heuristic(&self) -> Heuristic
pub fn set_point_solid(&mut self, id: Vector2i)
pub fn set_point_solid(&mut self, id: Vector2i)
To set the default parameters, use Self::set_point_solid_ex
and its builder methods. See the book for detailed usage instructions.
pub fn set_point_solid_ex<'a>(&'a mut self, id: Vector2i) -> ExSetPointSolid<'a>
pub fn is_point_solid(&self, id: Vector2i) -> bool
pub fn set_point_weight_scale(&mut self, id: Vector2i, weight_scale: f32)
pub fn get_point_weight_scale(&self, id: Vector2i) -> f32
pub fn fill_solid_region(&mut self, region: Rect2i)
pub fn fill_solid_region(&mut self, region: Rect2i)
To set the default parameters, use Self::fill_solid_region_ex
and its builder methods. See the book for detailed usage instructions.
pub fn fill_solid_region_ex<'a>( &'a mut self, region: Rect2i, ) -> ExFillSolidRegion<'a>
pub fn fill_weight_scale_region(&mut self, region: Rect2i, weight_scale: f32)
pub fn clear(&mut self)
pub fn get_point_position(&self, id: Vector2i) -> Vector2
pub fn get_point_data_in_region(&self, region: Rect2i) -> Array<Dictionary>
pub fn get_point_path(
&mut self,
from_id: Vector2i,
to_id: Vector2i,
) -> PackedArray<Vector2>
pub fn get_point_path( &mut self, from_id: Vector2i, to_id: Vector2i, ) -> PackedArray<Vector2>
To set the default parameters, use Self::get_point_path_ex
and its builder methods. See the book for detailed usage instructions.
pub fn get_point_path_ex<'a>( &'a mut self, from_id: Vector2i, to_id: Vector2i, ) -> ExGetPointPath<'a>
pub fn get_id_path(
&mut self,
from_id: Vector2i,
to_id: Vector2i,
) -> Array<Vector2i>
pub fn get_id_path( &mut self, from_id: Vector2i, to_id: Vector2i, ) -> Array<Vector2i>
To set the default parameters, use Self::get_id_path_ex
and its builder methods. See the book for detailed usage instructions.
pub fn get_id_path_ex<'a>( &'a mut self, from_id: Vector2i, to_id: Vector2i, ) -> ExGetIdPath<'a>
Methods from Deref<Target = RefCounted>§
pub fn get_reference_count(&self) -> i32
Methods from Deref<Target = Object>§
pub fn get_script(&self) -> Option<Gd<Script>>
pub fn set_script(&mut self, script: impl AsArg<Option<Gd<Script>>>)
pub fn connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error
pub fn connect_flags( &mut self, signal: impl AsArg<StringName>, callable: &Callable, flags: ConnectFlags, ) -> Error
pub fn get_class(&self) -> GString
pub fn is_class(&self, class: impl AsArg<GString>) -> bool
pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)
pub fn get(&self, property: impl AsArg<StringName>) -> Variant
pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )
pub fn get_indexed(&self, property_path: impl AsArg<NodePath>) -> Variant
pub fn get_property_list(&self) -> Array<Dictionary>
pub fn get_method_list(&self) -> Array<Dictionary>
pub fn property_can_revert(&self, property: impl AsArg<StringName>) -> bool
pub fn property_get_revert(&self, property: impl AsArg<StringName>) -> Variant
pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)
pub fn remove_meta(&mut self, name: impl AsArg<StringName>)
pub fn get_meta(&self, name: impl AsArg<StringName>) -> Variant
pub fn get_meta(&self, name: impl AsArg<StringName>) -> Variant
To set the default parameters, use Self::get_meta_ex
and its builder methods. See the book for detailed usage instructions.
pub fn get_meta_ex<'a>( &'a self, name: impl AsArg<StringName> + 'a, ) -> ExGetMeta<'a>
pub fn has_meta(&self, name: impl AsArg<StringName>) -> bool
pub fn get_meta_list(&self) -> Array<StringName>
pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)
pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)
To set the default parameters, use Self::add_user_signal_ex
and its builder methods. See the book for detailed usage instructions.
pub fn add_user_signal_ex<'a>( &'a mut self, signal: impl AsArg<GString> + 'a, ) -> ExAddUserSignal<'a>
pub fn has_user_signal(&self, signal: impl AsArg<StringName>) -> bool
pub fn remove_user_signal(&mut self, signal: impl AsArg<StringName>)
pub fn emit_signal(
&mut self,
signal: impl AsArg<StringName>,
varargs: &[Variant],
) -> Error
pub fn emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Error
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_emit_signal(
&mut self,
signal: impl AsArg<StringName>,
varargs: &[Variant],
) -> Result<Error, CallError>
pub fn try_emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Error, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn call(
&mut self,
method: impl AsArg<StringName>,
varargs: &[Variant],
) -> Variant
pub fn call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_call(
&mut self,
method: impl AsArg<StringName>,
varargs: &[Variant],
) -> Result<Variant, CallError>
pub fn try_call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn call_deferred(
&mut self,
method: impl AsArg<StringName>,
varargs: &[Variant],
) -> Variant
pub fn call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_call_deferred(
&mut self,
method: impl AsArg<StringName>,
varargs: &[Variant],
) -> Result<Variant, CallError>
pub fn try_call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn set_deferred( &mut self, property: impl AsArg<StringName>, value: &Variant, )
pub fn callv( &mut self, method: impl AsArg<StringName>, arg_array: &Array<Variant>, ) -> Variant
pub fn has_method(&self, method: impl AsArg<StringName>) -> bool
pub fn get_method_argument_count(&self, method: impl AsArg<StringName>) -> i32
pub fn has_signal(&self, signal: impl AsArg<StringName>) -> bool
pub fn get_signal_list(&self) -> Array<Dictionary>
pub fn get_signal_connection_list( &self, signal: impl AsArg<StringName>, ) -> Array<Dictionary>
pub fn get_incoming_connections(&self) -> Array<Dictionary>
pub fn disconnect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, )
pub fn is_connected( &self, signal: impl AsArg<StringName>, callable: &Callable, ) -> bool
pub fn has_connections(&self, signal: impl AsArg<StringName>) -> bool
pub fn set_block_signals(&mut self, enable: bool)
pub fn is_blocking_signals(&self) -> bool
pub fn notify_property_list_changed(&mut self)
pub fn set_message_translation(&mut self, enable: bool)
pub fn can_translate_messages(&self) -> bool
pub fn tr(&self, message: impl AsArg<StringName>) -> GString
pub fn tr(&self, message: impl AsArg<StringName>) -> GString
To set the default parameters, use Self::tr_ex
and its builder methods. See the book for detailed usage instructions.
pub fn tr_ex<'a>(&'a self, message: impl AsArg<StringName> + 'a) -> ExTr<'a>
pub fn tr_n(
&self,
message: impl AsArg<StringName>,
plural_message: impl AsArg<StringName>,
n: i32,
) -> GString
pub fn tr_n( &self, message: impl AsArg<StringName>, plural_message: impl AsArg<StringName>, n: i32, ) -> GString
To set the default parameters, use Self::tr_n_ex
and its builder methods. See the book for detailed usage instructions.
pub fn tr_n_ex<'a>( &'a self, message: impl AsArg<StringName> + 'a, plural_message: impl AsArg<StringName> + 'a, n: i32, ) -> ExTrN<'a>
pub fn get_translation_domain(&self) -> StringName
pub fn set_translation_domain(&mut self, domain: impl AsArg<StringName>)
pub fn is_queued_for_deletion(&self) -> bool
pub fn cancel_free(&mut self)
pub fn notify(&mut self, what: ObjectNotification)
pub fn notify(&mut self, what: ObjectNotification)
⚠️ Sends a Godot notification to all classes inherited by the object.
Triggers calls to on_notification()
, and depending on the notification, also to Godot’s lifecycle callbacks such as ready()
.
Starts from the highest ancestor (the Object
class) and goes down the hierarchy.
See also Godot docs for Object::notification()
.
§Panics
If you call this method on a user-defined object while holding a GdRef
or GdMut
guard on the instance, you will encounter
a panic. The reason is that the receiving virtual method on_notification()
acquires a GdMut
lock dynamically, which must
be exclusive.
pub fn notify_reversed(&mut self, what: ObjectNotification)
pub fn notify_reversed(&mut self, what: ObjectNotification)
⚠️ Like Self::notify()
, but starts at the most-derived class and goes up the hierarchy.
See docs of that method, including the panics.
Trait Implementations§
§impl Bounds for AStarGrid2D
impl Bounds for AStarGrid2D
§type Memory = MemRefCounted
type Memory = MemRefCounted
§type Declarer = DeclEngine
type Declarer = DeclEngine
§impl Debug for AStarGrid2D
impl Debug for AStarGrid2D
§impl Deref for AStarGrid2D
impl Deref for AStarGrid2D
§type Target = RefCounted
type Target = RefCounted
§fn deref(&self) -> &<AStarGrid2D as Deref>::Target
fn deref(&self) -> &<AStarGrid2D as Deref>::Target
§impl DerefMut for AStarGrid2D
impl DerefMut for AStarGrid2D
§fn deref_mut(&mut self) -> &mut <AStarGrid2D as Deref>::Target
fn deref_mut(&mut self) -> &mut <AStarGrid2D as Deref>::Target
§impl GodotClass for AStarGrid2D
impl GodotClass for AStarGrid2D
§const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene
const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene
§type Base = RefCounted
type Base = RefCounted
T
. This is always a Godot engine class.§fn class_id() -> ClassId
fn class_id() -> ClassId
§fn class_name() -> ClassId
fn class_name() -> ClassId
class_id()
§fn inherits<Base>() -> boolwhere
Base: GodotClass,
fn inherits<Base>() -> boolwhere
Base: GodotClass,
§impl Inherits<Object> for AStarGrid2D
impl Inherits<Object> for AStarGrid2D
§const IS_SAME_CLASS: bool = false
const IS_SAME_CLASS: bool = false
Self == Base
. Read more§impl Inherits<RefCounted> for AStarGrid2D
impl Inherits<RefCounted> for AStarGrid2D
§const IS_SAME_CLASS: bool = false
const IS_SAME_CLASS: bool = false
Self == Base
. Read more§impl WithSignals for AStarGrid2D
impl WithSignals for AStarGrid2D
§type SignalCollection<'c, C: WithSignals> = SignalsOfObject<'c, C>
type SignalCollection<'c, C: WithSignals> = SignalsOfObject<'c, C>
impl GodotDefault for AStarGrid2D
Auto Trait Implementations§
impl Freeze for AStarGrid2D
impl RefUnwindSafe for AStarGrid2D
impl !Send for AStarGrid2D
impl !Sync for AStarGrid2D
impl Unpin for AStarGrid2D
impl UnwindSafe for AStarGrid2D
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Inherits<T> for Twhere
T: GodotClass,
impl<T> Inherits<T> for Twhere
T: GodotClass,
§const IS_SAME_CLASS: bool = true
const IS_SAME_CLASS: bool = true
Self == Base
. Read more