NavigationPathQueryParameters2D

Documentation

Overview

Package NavigationPathQueryParameters2D provides methods for working with NavigationPathQueryParameters2D object instances.

Index

• type Advanced
• type Any
• type Instance
  • func New() Instance
  • func (self Instance) AsNavigationPathQueryParameters2D() Instance
  • func (self Instance) AsObject() [1]gd.Object
  • func (self Instance) AsRefCounted() [1]gd.RefCounted
  • func (self Instance) Map() RID.Any
  • func (self Instance) MetadataFlags() gdclass.NavigationPathQueryParameters2DPathMetadataFlags
  • func (self Instance) NavigationLayers() int
  • func (self Instance) PathPostprocessing() gdclass.NavigationPathQueryParameters2DPathPostProcessing
  • func (self Instance) PathfindingAlgorithm() gdclass.NavigationPathQueryParameters2DPathfindingAlgorithm
  • func (self Instance) SetMap(value RID.Any)
  • func (self Instance) SetMetadataFlags(value gdclass.NavigationPathQueryParameters2DPathMetadataFlags)
  • func (self Instance) SetNavigationLayers(value int)
  • func (self Instance) SetPathPostprocessing(value gdclass.NavigationPathQueryParameters2DPathPostProcessing)
  • func (self Instance) SetPathfindingAlgorithm(value gdclass.NavigationPathQueryParameters2DPathfindingAlgorithm)
  • func (self Instance) SetSimplifyEpsilon(value Float.X)
  • func (self Instance) SetSimplifyPath(value bool)
  • func (self Instance) SetStartPosition(value Vector2.XY)
  • func (self Instance) SetTargetPosition(value Vector2.XY)
  • func (self Instance) SimplifyEpsilon() Float.X
  • func (self Instance) SimplifyPath() bool
  • func (self Instance) StartPosition() Vector2.XY
  • func (self Instance) TargetPosition() Vector2.XY
  • func (self *Instance) UnsafePointer() unsafe.Pointer
  • func (self Instance) Virtual(name string) reflect.Value
• type PathMetadataFlags
• type PathPostProcessing
• type PathfindingAlgorithm

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
	AsNavigationPathQueryParameters2D() Instance
}

type Instance

type Instance [1]gdclass.NavigationPathQueryParameters2D

By changing various properties of this object, such as the start and target position, you can configure path queries to the [NavigationServer2D].

var Nil Instance

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

func New

func New() Instance

func (Instance) AsNavigationPathQueryParameters2D

func (self Instance) AsNavigationPathQueryParameters2D() Instance

func (Instance) AsObject

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

func (Instance) AsRefCounted

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

func (Instance) Map

func (self Instance) Map() RID.Any

func (Instance) MetadataFlags

func (self Instance) MetadataFlags() gdclass.NavigationPathQueryParameters2DPathMetadataFlags

func (Instance) NavigationLayers

func (self Instance) NavigationLayers() int

func (Instance) PathPostprocessing

func (self Instance) PathPostprocessing() gdclass.NavigationPathQueryParameters2DPathPostProcessing

func (Instance) PathfindingAlgorithm

func (self Instance) PathfindingAlgorithm() gdclass.NavigationPathQueryParameters2DPathfindingAlgorithm

func (Instance) SetMap

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

func (Instance) SetMetadataFlags

func (self Instance) SetMetadataFlags(value gdclass.NavigationPathQueryParameters2DPathMetadataFlags)

func (Instance) SetNavigationLayers

func (self Instance) SetNavigationLayers(value int)

func (Instance) SetPathPostprocessing

func (self Instance) SetPathPostprocessing(value gdclass.NavigationPathQueryParameters2DPathPostProcessing)

func (Instance) SetPathfindingAlgorithm

func (self Instance) SetPathfindingAlgorithm(value gdclass.NavigationPathQueryParameters2DPathfindingAlgorithm)

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 Vector2.XY)

func (Instance) SetTargetPosition

func (self Instance) SetTargetPosition(value Vector2.XY)

func (Instance) SimplifyEpsilon

func (self Instance) SimplifyEpsilon() Float.X

func (Instance) SimplifyPath

func (self Instance) SimplifyPath() bool

func (Instance) StartPosition

func (self Instance) StartPosition() Vector2.XY

func (Instance) TargetPosition

func (self Instance) TargetPosition() Vector2.XY

func (*Instance) UnsafePointer

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) Virtual

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

type PathMetadataFlags

type PathMetadataFlags = gdclass.NavigationPathQueryParameters2DPathMetadataFlags //gd:NavigationPathQueryParameters2D.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 [RID]s of the regions and links that each point of the path goes through.*/
	PathMetadataIncludeRids PathMetadataFlags = 2
	/*Include the [code]ObjectID[/code]s of the [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 = gdclass.NavigationPathQueryParameters2DPathPostProcessing //gd:NavigationPathQueryParameters2D.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
)

type PathfindingAlgorithm

type PathfindingAlgorithm = gdclass.NavigationPathQueryParameters2DPathfindingAlgorithm //gd:NavigationPathQueryParameters2D.PathfindingAlgorithm

const (
	/*The path query uses the default A* pathfinding algorithm.*/
	PathfindingAlgorithmAstar PathfindingAlgorithm = 0
)