Logo
  • Overview
  • Getting Started
  • Class Reference
  • Godot Class Reference
    • All classes
    • Globals
    • Nodes
      • Node
      • AcceptDialog
      • AnimatableBody2D
      • AnimatableBody3D
      • AnimatedSprite2D
      • AnimatedSprite3D
      • AnimationMixer
      • AnimationPlayer
      • AnimationTree
      • Area2D
      • Area3D
      • AspectRatioContainer
      • AudioListener2D
      • AudioListener3D
      • AudioStreamPlayer
      • AudioStreamPlayer2D
      • AudioStreamPlayer3D
      • BackBufferCopy
      • BaseButton
      • Bone2D
      • BoneAttachment3D
      • BoxContainer
      • Button
      • Camera2D
      • Camera3D
      • CanvasGroup
      • CanvasItem
      • CanvasLayer
      • CanvasModulate
      • CenterContainer
      • CharacterBody2D
      • CharacterBody3D
      • ChatConsole
      • CheckBox
      • CheckButton
      • ClientKeys
      • CodeEdit
      • CollisionObject2D
      • CollisionObject3D
      • CollisionPolygon2D
      • CollisionPolygon3D
      • CollisionShape2D
      • CollisionShape3D
      • ColorPicker
      • ColorPickerButton
      • ColorRect
      • ConeTwistJoint3D
      • ConfirmationDialog
      • Container
      • Control
      • CPUParticles2D
      • CPUParticles3D
      • CSGBox3D
      • CSGCombiner3D
      • CSGCylinder3D
      • CSGMesh3D
      • CSGPolygon3D
      • CSGPrimitive3D
      • CSGShape3D
      • CSGSphere3D
      • CSGTorus3D
      • DampedSpringJoint2D
      • Decal
      • DeviceAuthUI
      • DirectionalLight2D
      • DirectionalLight3D
      • EditorCommandPalette
      • EditorFileDialog
      • EditorFileSystem
      • EditorInspector
      • EditorPlugin
      • EditorProperty
      • EditorResourcePicker
      • EditorResourcePreview
      • EditorScriptPicker
      • EditorSpinSlider
      • FileDialog
      • FileSystemDock
      • FlowContainer
      • FogVolume
      • Generic6DOFJoint3D
      • GeometryInstance3D
      • GPUParticles2D
      • GPUParticles3D
      • GPUParticlesAttractor3D
      • GPUParticlesAttractorBox3D
      • GPUParticlesAttractorSphere3D
      • GPUParticlesAttractorVectorField3D
      • GPUParticlesCollision3D
      • GPUParticlesCollisionBox3D
      • GPUParticlesCollisionHeightField3D
      • GPUParticlesCollisionSDF3D
      • GPUParticlesCollisionSphere3D
      • GraphEdit
      • GraphElement
      • GraphFrame
      • GraphNode
      • GridContainer
      • GridMap
      • GrooveJoint2D
      • HBoxContainer
      • HFlowContainer
      • HingeJoint3D
      • HScrollBar
      • HSeparator
      • HSlider
      • HSplitContainer
      • HTTPRequest
      • ImporterMeshInstance3D
      • InstancePlaceholder
      • ItemList
      • Joint2D
      • Joint3D
      • Label
      • Label3D
      • Light2D
      • Light3D
      • LightmapGI
      • LightmapProbe
      • LightOccluder2D
      • Line2D
      • LineEdit
      • LinkButton
      • MarginContainer
      • Marker2D
      • Marker3D
      • MenuBar
      • MenuButton
      • MeshInstance2D
      • MeshInstance3D
      • MessagePanel
      • MissingNode
      • MultiMeshInstance2D
      • MultiMeshInstance3D
      • MultiplayerSpawner
      • MultiplayerSynchronizer
      • NavigationAgent2D
      • NavigationAgent3D
        • Properties
        • Methods
        • Signals
        • Property Descriptions
        • Method Descriptions
      • NavigationLink2D
      • NavigationLink3D
      • NavigationObstacle2D
      • NavigationObstacle3D
      • NavigationRegion2D
      • NavigationRegion3D
      • NinePatchRect
      • Node2D
      • Node3D
      • OccluderInstance3D
      • OmniLight3D
      • OpenXRCompositionLayer
      • OpenXRCompositionLayerCylinder
      • OpenXRCompositionLayerEquirect
      • OpenXRCompositionLayerQuad
      • OpenXRHand
      • OptionButton
      • Panel
      • PanelContainer
      • Parallax2D
      • ParallaxBackground
      • ParallaxLayer
      • Path2D
      • Path3D
      • PathFollow2D
      • PathFollow3D
      • PhysicalBone2D
      • PhysicalBone3D
      • PhysicalBoneSimulator3D
      • PhysicsBody2D
      • PhysicsBody3D
      • PinJoint2D
      • PinJoint3D
      • PointLight2D
      • Polygon2D
      • Popup
      • PopupMenu
      • PopupPanel
      • ProgressBar
      • Range
      • RayCast2D
      • RayCast3D
      • ReferenceRect
      • ReflectionProbe
      • RemoteTransform2D
      • RemoteTransform3D
      • ResourcePreloader
      • RichTextLabel
      • RigidBody2D
      • RigidBody3D
      • RootMotionView
      • ScopeLocker
      • ScriptCreateDialog
      • ScriptEditor
      • ScriptEditorBase
      • ScrollBar
      • ScrollContainer
      • Separator
      • ShaderGlobalsOverride
      • ShapeCast2D
      • ShapeCast3D
      • Skeleton2D
      • Skeleton3D
      • SkeletonIK3D
      • SkeletonModifier3D
      • Slider
      • SliderJoint3D
      • SoftBody3D
      • SpinBox
      • SplitContainer
      • SpotLight3D
      • SpringArm3D
      • Sprite2D
      • Sprite3D
      • SpriteBase3D
      • StaticBody2D
      • StaticBody3D
      • StatusIndicator
      • SubViewport
      • SubViewportContainer
      • TabBar
      • TabContainer
      • TextEdit
      • TextureButton
      • TextureProgressBar
      • TextureRect
      • TileMap
      • TileMapLayer
      • Timer
      • TouchScreenButton
      • Tree
      • VBoxContainer
      • VehicleBody3D
      • VehicleWheel3D
      • VFlowContainer
      • VideoStreamPlayer
      • Viewport
      • VisibleOnScreenEnabler2D
      • VisibleOnScreenEnabler3D
      • VisibleOnScreenNotifier2D
      • VisibleOnScreenNotifier3D
      • VisualInstance3D
      • VoxelGI
      • VScrollBar
      • VSeparator
      • VSlider
      • VSplitContainer
      • Window
      • WorldEnvironment
      • XRAnchor3D
      • XRBodyModifier3D
      • XRCamera3D
      • XRController3D
      • XRFaceModifier3D
      • XRHandModifier3D
      • XRNode3D
      • XROrigin3D
    • Resources
    • Other objects
    • Editor-only
    • Variant types
  • Contact
Jam Launch
  • Godot Class Reference
  • All classes
  • NavigationAgent3D
  • View page source

NavigationAgent3D

Inherits: Node < Object

There is currently no description for this class. Please help us by contributing one!

Properties

bool

avoidance_enabled

false

int

avoidance_layers

1

int

avoidance_mask

1

float

avoidance_priority

1.0

bool

debug_enabled

false

Color

debug_path_custom_color

Color(1, 1, 1, 1)

float

debug_path_custom_point_size

4.0

bool

debug_use_custom

false

float

height

1.0

bool

keep_y_velocity

true

int

max_neighbors

10

float

max_speed

10.0

int

navigation_layers

1

float

neighbor_distance

50.0

float

path_desired_distance

1.0

float

path_height_offset

0.0

float

path_max_distance

5.0

BitField<PathMetadataFlags>

path_metadata_flags

7

PathPostProcessing

path_postprocessing

0

PathfindingAlgorithm

pathfinding_algorithm

0

float

radius

0.5

float

simplify_epsilon

0.0

bool

simplify_path

false

float

target_desired_distance

1.0

Vector3

target_position

Vector3(0, 0, 0)

float

time_horizon_agents

1.0

float

time_horizon_obstacles

0.0

bool

use_3d_avoidance

false

Vector3

velocity

Vector3(0, 0, 0)

Methods

float

distance_to_target ( ) const

bool

get_avoidance_layer_value ( int layer_number ) const

bool

get_avoidance_mask_value ( int mask_number ) const

PackedVector3Array

get_current_navigation_path ( ) const

int

get_current_navigation_path_index ( ) const

NavigationPathQueryResult3D

get_current_navigation_result ( ) const

Vector3

get_final_position ( )

bool

get_navigation_layer_value ( int layer_number ) const

RID

get_navigation_map ( ) const

Vector3

get_next_path_position ( )

RID

get_rid ( ) const

bool

is_navigation_finished ( )

bool

is_target_reachable ( )

bool

is_target_reached ( ) const

void

set_avoidance_layer_value ( int layer_number, bool value )

void

set_avoidance_mask_value ( int mask_number, bool value )

void

set_navigation_layer_value ( int layer_number, bool value )

void

set_navigation_map ( RID navigation_map )

void

set_velocity_forced ( Vector3 velocity )


Signals

link_reached ( Dictionary details )

There is currently no description for this signal. Please help us by contributing one!


navigation_finished ( )

There is currently no description for this signal. Please help us by contributing one!


path_changed ( )

There is currently no description for this signal. Please help us by contributing one!


target_reached ( )

There is currently no description for this signal. Please help us by contributing one!


velocity_computed ( Vector3 safe_velocity )

There is currently no description for this signal. Please help us by contributing one!


waypoint_reached ( Dictionary details )

There is currently no description for this signal. Please help us by contributing one!


Property Descriptions

bool avoidance_enabled = false

  • void set_avoidance_enabled ( bool value )

  • bool get_avoidance_enabled ( )

There is currently no description for this property. Please help us by contributing one!


int avoidance_layers = 1

  • void set_avoidance_layers ( int value )

  • int get_avoidance_layers ( )

There is currently no description for this property. Please help us by contributing one!


int avoidance_mask = 1

  • void set_avoidance_mask ( int value )

  • int get_avoidance_mask ( )

There is currently no description for this property. Please help us by contributing one!


float avoidance_priority = 1.0

  • void set_avoidance_priority ( float value )

  • float get_avoidance_priority ( )

There is currently no description for this property. Please help us by contributing one!


bool debug_enabled = false

  • void set_debug_enabled ( bool value )

  • bool get_debug_enabled ( )

There is currently no description for this property. Please help us by contributing one!


Color debug_path_custom_color = Color(1, 1, 1, 1)

  • void set_debug_path_custom_color ( Color value )

  • Color get_debug_path_custom_color ( )

There is currently no description for this property. Please help us by contributing one!


float debug_path_custom_point_size = 4.0

  • void set_debug_path_custom_point_size ( float value )

  • float get_debug_path_custom_point_size ( )

There is currently no description for this property. Please help us by contributing one!


bool debug_use_custom = false

  • void set_debug_use_custom ( bool value )

  • bool get_debug_use_custom ( )

There is currently no description for this property. Please help us by contributing one!


float height = 1.0

  • void set_height ( float value )

  • float get_height ( )

There is currently no description for this property. Please help us by contributing one!


bool keep_y_velocity = true

  • void set_keep_y_velocity ( bool value )

  • bool get_keep_y_velocity ( )

There is currently no description for this property. Please help us by contributing one!


int max_neighbors = 10

  • void set_max_neighbors ( int value )

  • int get_max_neighbors ( )

There is currently no description for this property. Please help us by contributing one!


float max_speed = 10.0

  • void set_max_speed ( float value )

  • float get_max_speed ( )

There is currently no description for this property. Please help us by contributing one!


int navigation_layers = 1

  • void set_navigation_layers ( int value )

  • int get_navigation_layers ( )

There is currently no description for this property. Please help us by contributing one!


float neighbor_distance = 50.0

  • void set_neighbor_distance ( float value )

  • float get_neighbor_distance ( )

There is currently no description for this property. Please help us by contributing one!


float path_desired_distance = 1.0

  • void set_path_desired_distance ( float value )

  • float get_path_desired_distance ( )

There is currently no description for this property. Please help us by contributing one!


float path_height_offset = 0.0

  • void set_path_height_offset ( float value )

  • float get_path_height_offset ( )

There is currently no description for this property. Please help us by contributing one!


float path_max_distance = 5.0

  • void set_path_max_distance ( float value )

  • float get_path_max_distance ( )

There is currently no description for this property. Please help us by contributing one!


BitField<PathMetadataFlags> path_metadata_flags = 7

  • void set_path_metadata_flags ( BitField<PathMetadataFlags> value )

  • BitField<PathMetadataFlags> get_path_metadata_flags ( )

There is currently no description for this property. Please help us by contributing one!


PathPostProcessing path_postprocessing = 0

  • void set_path_postprocessing ( PathPostProcessing value )

  • PathPostProcessing get_path_postprocessing ( )

There is currently no description for this property. Please help us by contributing one!


PathfindingAlgorithm pathfinding_algorithm = 0

  • void set_pathfinding_algorithm ( PathfindingAlgorithm value )

  • PathfindingAlgorithm get_pathfinding_algorithm ( )

There is currently no description for this property. Please help us by contributing one!


float radius = 0.5

  • void set_radius ( float value )

  • float get_radius ( )

There is currently no description for this property. Please help us by contributing one!


float simplify_epsilon = 0.0

  • void set_simplify_epsilon ( float value )

  • float get_simplify_epsilon ( )

There is currently no description for this property. Please help us by contributing one!


bool simplify_path = false

  • void set_simplify_path ( bool value )

  • bool get_simplify_path ( )

There is currently no description for this property. Please help us by contributing one!


float target_desired_distance = 1.0

  • void set_target_desired_distance ( float value )

  • float get_target_desired_distance ( )

There is currently no description for this property. Please help us by contributing one!


Vector3 target_position = Vector3(0, 0, 0)

  • void set_target_position ( Vector3 value )

  • Vector3 get_target_position ( )

There is currently no description for this property. Please help us by contributing one!


float time_horizon_agents = 1.0

  • void set_time_horizon_agents ( float value )

  • float get_time_horizon_agents ( )

There is currently no description for this property. Please help us by contributing one!


float time_horizon_obstacles = 0.0

  • void set_time_horizon_obstacles ( float value )

  • float get_time_horizon_obstacles ( )

There is currently no description for this property. Please help us by contributing one!


bool use_3d_avoidance = false

  • void set_use_3d_avoidance ( bool value )

  • bool get_use_3d_avoidance ( )

There is currently no description for this property. Please help us by contributing one!


Vector3 velocity = Vector3(0, 0, 0)

  • void set_velocity ( Vector3 value )

  • Vector3 get_velocity ( )

There is currently no description for this property. Please help us by contributing one!


Method Descriptions

float distance_to_target ( ) const

There is currently no description for this method. Please help us by contributing one!


bool get_avoidance_layer_value ( int layer_number ) const

There is currently no description for this method. Please help us by contributing one!


bool get_avoidance_mask_value ( int mask_number ) const

There is currently no description for this method. Please help us by contributing one!


PackedVector3Array get_current_navigation_path ( ) const

There is currently no description for this method. Please help us by contributing one!


int get_current_navigation_path_index ( ) const

There is currently no description for this method. Please help us by contributing one!


NavigationPathQueryResult3D get_current_navigation_result ( ) const

There is currently no description for this method. Please help us by contributing one!


Vector3 get_final_position ( )

There is currently no description for this method. Please help us by contributing one!


bool get_navigation_layer_value ( int layer_number ) const

There is currently no description for this method. Please help us by contributing one!


RID get_navigation_map ( ) const

There is currently no description for this method. Please help us by contributing one!


Vector3 get_next_path_position ( )

There is currently no description for this method. Please help us by contributing one!


RID get_rid ( ) const

There is currently no description for this method. Please help us by contributing one!


bool is_navigation_finished ( )

There is currently no description for this method. Please help us by contributing one!


bool is_target_reachable ( )

There is currently no description for this method. Please help us by contributing one!


bool is_target_reached ( ) const

There is currently no description for this method. Please help us by contributing one!


void set_avoidance_layer_value ( int layer_number, bool value )

There is currently no description for this method. Please help us by contributing one!


void set_avoidance_mask_value ( int mask_number, bool value )

There is currently no description for this method. Please help us by contributing one!


void set_navigation_layer_value ( int layer_number, bool value )

There is currently no description for this method. Please help us by contributing one!


void set_navigation_map ( RID navigation_map )

There is currently no description for this method. Please help us by contributing one!


void set_velocity_forced ( Vector3 velocity )

There is currently no description for this method. Please help us by contributing one!

Previous Next

© Copyright 2024, The Jam Launch Syndicate.

Built with Sphinx using a theme provided by Read the Docs.