NavigationPathQueryParameters3D

package
v0.0.0-...-535787f Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 16, 2025 License: MIT Imports: 23 Imported by: 0

Documentation

Overview

By changing various properties of this object, such as the start and target position, you can configure path queries to the graphics.gd/classdb/NavigationServer3D.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Advanced

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any

type Any interface {
	gd.IsClass
	AsNavigationPathQueryParameters3D() Instance
}

type Extension

type Extension[T gdclass.Interface] struct{ gdclass.Extension[T, Instance] }

Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension

func (*Extension[T]) AsNavigationPathQueryParameters3D

func (self *Extension[T]) AsNavigationPathQueryParameters3D() Instance

func (*Extension[T]) AsObject

func (self *Extension[T]) AsObject() [1]gd.Object

func (*Extension[T]) AsRefCounted

func (self *Extension[T]) AsRefCounted() [1]gd.RefCounted

type ID

type ID Object.ID

ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.

func (ID) Instance

func (id ID) Instance() (Instance, bool)

type Instance

Instance of the class with convieniently typed arguments and results.

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New

func New() Instance

func (Instance) AsNavigationPathQueryParameters3D

func (self Instance) AsNavigationPathQueryParameters3D() Instance

func (Instance) AsObject

func (self Instance) AsObject() [1]gd.Object

func (Instance) AsRefCounted

func (self Instance) AsRefCounted() [1]gd.RefCounted

func (Instance) ExcludedRegions

func (self Instance) ExcludedRegions() []RID.Any

func (Instance) ID

func (self Instance) ID() ID

func (Instance) IncludedRegions

func (self Instance) IncludedRegions() []RID.Any

func (Instance) Map

func (self Instance) Map() RID.Any

func (Instance) MetadataFlags

func (self Instance) MetadataFlags() PathMetadataFlags

func (Instance) NavigationLayers

func (self Instance) NavigationLayers() int

func (Instance) PathPostprocessing

func (self Instance) PathPostprocessing() PathPostProcessing

func (Instance) PathReturnMaxLength

func (self Instance) PathReturnMaxLength() Float.X

func (Instance) PathReturnMaxRadius

func (self Instance) PathReturnMaxRadius() Float.X

func (Instance) PathSearchMaxDistance

func (self Instance) PathSearchMaxDistance() Float.X

func (Instance) PathSearchMaxPolygons

func (self Instance) PathSearchMaxPolygons() int

func (Instance) PathfindingAlgorithm

func (self Instance) PathfindingAlgorithm() PathfindingAlgorithm

func (Instance) SetExcludedRegions

func (self Instance) SetExcludedRegions(value []RID.Any)

func (Instance) SetIncludedRegions

func (self Instance) SetIncludedRegions(value []RID.Any)

func (Instance) SetMap

func (self Instance) SetMap(value RID.Any)

func (Instance) SetMetadataFlags

func (self Instance) SetMetadataFlags(value PathMetadataFlags)

func (Instance) SetNavigationLayers

func (self Instance) SetNavigationLayers(value int)

func (*Instance) SetObject

func (self *Instance) SetObject(obj [1]gd.Object) bool

func (Instance) SetPathPostprocessing

func (self Instance) SetPathPostprocessing(value PathPostProcessing)

func (Instance) SetPathReturnMaxLength

func (self Instance) SetPathReturnMaxLength(value Float.X)

func (Instance) SetPathReturnMaxRadius

func (self Instance) SetPathReturnMaxRadius(value Float.X)

func (Instance) SetPathSearchMaxDistance

func (self Instance) SetPathSearchMaxDistance(value Float.X)

func (Instance) SetPathSearchMaxPolygons

func (self Instance) SetPathSearchMaxPolygons(value int)

func (Instance) SetPathfindingAlgorithm

func (self Instance) SetPathfindingAlgorithm(value PathfindingAlgorithm)

func (Instance) SetSimplifyEpsilon

func (self Instance) SetSimplifyEpsilon(value Float.X)

func (Instance) SetSimplifyPath

func (self Instance) SetSimplifyPath(value bool)

func (Instance) SetStartPosition

func (self Instance) SetStartPosition(value Vector3.XYZ)

func (Instance) SetTargetPosition

func (self Instance) SetTargetPosition(value Vector3.XYZ)

func (Instance) SimplifyEpsilon

func (self Instance) SimplifyEpsilon() Float.X

func (Instance) SimplifyPath

func (self Instance) SimplifyPath() bool

func (Instance) StartPosition

func (self Instance) StartPosition() Vector3.XYZ

func (Instance) TargetPosition

func (self Instance) TargetPosition() Vector3.XYZ

func (Instance) Virtual

func (self Instance) Virtual(name string) reflect.Value

type PathMetadataFlags

type PathMetadataFlags int //gd:NavigationPathQueryParameters3D.PathMetadataFlags
const (
	// Don't include any additional metadata about the returned path.
	PathMetadataIncludeNone PathMetadataFlags = 0
	// Include the type of navigation primitive (region or link) that each point of the path goes through.
	PathMetadataIncludeTypes PathMetadataFlags = 1
	// Include the [Resource.ID]s of the regions and links that each point of the path goes through.
	PathMetadataIncludeRids PathMetadataFlags = 2
	// Include the ObjectIDs of the [graphics.gd/classdb/Object]s which manage the regions and links each point of the path goes through.
	PathMetadataIncludeOwners PathMetadataFlags = 4
	// Include all available metadata about the returned path.
	PathMetadataIncludeAll PathMetadataFlags = 7
)

type PathPostProcessing

type PathPostProcessing int //gd:NavigationPathQueryParameters3D.PathPostProcessing
const (
	// Applies a funnel algorithm to the raw path corridor found by the pathfinding algorithm. This will result in the shortest path possible inside the path corridor. This postprocessing very much depends on the navigation mesh polygon layout and the created corridor. Especially tile- or gridbased layouts can face artificial corners with diagonal movement due to a jagged path corridor imposed by the cell shapes.
	PathPostprocessingCorridorfunnel PathPostProcessing = 0
	// Centers every path position in the middle of the traveled navigation mesh polygon edge. This creates better paths for tile- or gridbased layouts that restrict the movement to the cells center.
	PathPostprocessingEdgecentered PathPostProcessing = 1
	// Applies no postprocessing and returns the raw path corridor as found by the pathfinding algorithm.
	PathPostprocessingNone PathPostProcessing = 2
)

type PathfindingAlgorithm

type PathfindingAlgorithm int //gd:NavigationPathQueryParameters3D.PathfindingAlgorithm
const (
	// The path query uses the default A* pathfinding algorithm.
	PathfindingAlgorithmAstar PathfindingAlgorithm = 0
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL