Struct NavigationMesh

#[repr(C)]
pub struct NavigationMesh { /* private fields */ }

Godot class NavigationMesh.

Inherits Resource.

Related symbols:

• navigation_mesh: sidecar module with related enum/flag types
• INavigationMesh: virtual methods

See also Godot docs for NavigationMesh.

Construction

This class is reference-counted. You can create a new instance using NavigationMesh::new_gd().

Implementations

impl NavigationMesh

pub fn set_sample_partition_type( &mut self, sample_partition_type: SamplePartitionType, )

pub fn get_sample_partition_type(&self) -> SamplePartitionType

pub fn set_parsed_geometry_type(&mut self, geometry_type: ParsedGeometryType)

pub fn get_parsed_geometry_type(&self) -> ParsedGeometryType

pub fn set_collision_mask(&mut self, mask: u32)

pub fn get_collision_mask(&self) -> u32

pub fn set_collision_mask_value(&mut self, layer_number: i32, value: bool)

pub fn get_collision_mask_value(&self, layer_number: i32) -> bool

pub fn set_source_geometry_mode(&mut self, mask: SourceGeometryMode)

pub fn get_source_geometry_mode(&self) -> SourceGeometryMode

pub fn set_source_group_name(&mut self, mask: impl AsArg<StringName>)

pub fn get_source_group_name(&self) -> StringName

pub fn set_cell_size(&mut self, cell_size: f32)

pub fn get_cell_size(&self) -> f32

pub fn set_cell_height(&mut self, cell_height: f32)

pub fn get_cell_height(&self) -> f32

pub fn set_border_size(&mut self, border_size: f32)

pub fn get_border_size(&self) -> f32

pub fn set_agent_height(&mut self, agent_height: f32)

pub fn get_agent_height(&self) -> f32

pub fn set_agent_radius(&mut self, agent_radius: f32)

pub fn get_agent_radius(&mut self) -> f32

pub fn set_agent_max_climb(&mut self, agent_max_climb: f32)

pub fn get_agent_max_climb(&self) -> f32

pub fn set_agent_max_slope(&mut self, agent_max_slope: f32)

pub fn get_agent_max_slope(&self) -> f32

pub fn set_region_min_size(&mut self, region_min_size: f32)

pub fn get_region_min_size(&self) -> f32

pub fn set_region_merge_size(&mut self, region_merge_size: f32)

pub fn get_region_merge_size(&self) -> f32

pub fn set_edge_max_length(&mut self, edge_max_length: f32)

pub fn get_edge_max_length(&self) -> f32

pub fn set_edge_max_error(&mut self, edge_max_error: f32)

pub fn get_edge_max_error(&self) -> f32

pub fn set_vertices_per_polygon(&mut self, vertices_per_polygon: f32)

pub fn get_vertices_per_polygon(&self) -> f32

pub fn set_detail_sample_distance(&mut self, detail_sample_dist: f32)

pub fn get_detail_sample_distance(&self) -> f32

pub fn set_detail_sample_max_error(&mut self, detail_sample_max_error: f32)

pub fn get_detail_sample_max_error(&self) -> f32

pub fn set_filter_low_hanging_obstacles( &mut self, filter_low_hanging_obstacles: bool, )

pub fn get_filter_low_hanging_obstacles(&self) -> bool

pub fn set_filter_ledge_spans(&mut self, filter_ledge_spans: bool)

pub fn get_filter_ledge_spans(&self) -> bool

pub fn set_filter_walkable_low_height_spans( &mut self, filter_walkable_low_height_spans: bool, )

pub fn get_filter_walkable_low_height_spans(&self) -> bool

pub fn set_filter_baking_aabb(&mut self, baking_aabb: Aabb)

pub fn get_filter_baking_aabb(&self) -> Aabb

pub fn set_filter_baking_aabb_offset(&mut self, baking_aabb_offset: Vector3)

pub fn get_filter_baking_aabb_offset(&self) -> Vector3

pub fn set_vertices(&mut self, vertices: &PackedVector3Array)

pub fn get_vertices(&self) -> PackedVector3Array

pub fn add_polygon(&mut self, polygon: &PackedInt32Array)

pub fn get_polygon_count(&self) -> i32

pub fn get_polygon(&mut self, idx: i32) -> PackedInt32Array

pub fn clear_polygons(&mut self)

pub fn create_from_mesh(&mut self, mesh: impl AsObjectArg<Mesh>)

pub fn clear(&mut self)

Methods from Deref<Target = Resource>

pub fn set_path(&mut self, path: impl AsArg<GString>)

pub fn take_over_path(&mut self, path: impl AsArg<GString>)

pub fn get_path(&self) -> GString

pub fn set_name(&mut self, name: impl AsArg<GString>)

pub fn get_name(&self) -> GString

pub fn get_rid(&self) -> Rid

pub fn set_local_to_scene(&mut self, enable: bool)

pub fn is_local_to_scene(&self) -> bool

pub fn get_local_scene(&self) -> Option<Gd<Node>>

pub fn setup_local_to_scene(&mut self)

pub fn set_scene_unique_id(&mut self, id: impl AsArg<GString>)

pub fn get_scene_unique_id(&self) -> GString

pub fn emit_changed(&mut self)

pub fn duplicate(&self) -> Option<Gd<Resource>>

To set the default parameters, use Self::duplicate_ex and its builder methods. See the book for detailed usage instructions.

pub fn duplicate_ex<'a>(&'a self) -> ExDuplicate<'a>

Methods from Deref<Target = RefCounted>

pub fn get_reference_count(&self) -> i32

Methods from Deref<Target = Object>

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_script(&mut self, script: &Variant)

pub fn get_script(&self) -> 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

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

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

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>

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

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>

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

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>

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 connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error

To set the default parameters, use Self::connect_ex and its builder methods. See the book for detailed usage instructions.

pub fn connect_ex<'a>( &'a mut self, signal: impl AsArg<StringName> + 'a, callable: &'a Callable, ) -> ExConnect<'a>

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

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

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 is_queued_for_deletion(&self) -> bool

pub fn cancel_free(&mut self)

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)

⚠️ 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 NavigationMesh

type Memory = MemRefCounted

Defines the memory strategy of the static type.

type Declarer = DeclEngine

Whether this class is a core Godot class provided by the engine, or declared by the user as a Rust struct.

impl Debug for NavigationMesh

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

Formats the value using the given formatter.

impl Deref for NavigationMesh

type Target = Resource

The resulting type after dereferencing.

fn deref(&self) -> &<NavigationMesh as Deref>::Target

Dereferences the value.

impl DerefMut for NavigationMesh

fn deref_mut(&mut self) -> &mut <NavigationMesh as Deref>::Target

Mutably dereferences the value.

impl GodotClass for NavigationMesh

const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene

Initialization level, during which this class should be initialized with Godot.

type Base = Resource

The immediate superclass of T. This is always a Godot engine class.

fn class_name() -> ClassName

The name of the class, under which it is registered in Godot.

fn inherits<U>() -> bool

where U: GodotClass,

Returns whether Self inherits from U.

impl GodotDefault for NavigationMesh

impl Inherits<Object> for NavigationMesh

impl Inherits<RefCounted> for NavigationMesh

impl Inherits<Resource> for NavigationMesh