Documentation
¶
Overview ¶
Package NavigationLink3D provides methods for working with NavigationLink3D object instances.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsNavigationLink3D() Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsNode3D() Node3D.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) Bidirectional() bool
- func (self Instance) Enabled() bool
- func (self Instance) EndPosition() Vector3.XYZ
- func (self Instance) EnterCost() Float.X
- func (self Instance) GetGlobalEndPosition() Vector3.XYZ
- func (self Instance) GetGlobalStartPosition() Vector3.XYZ
- func (self Instance) GetNavigationLayerValue(layer_number int) bool
- func (self Instance) GetNavigationMap() RID.NavigationMap3D
- func (self Instance) GetRid() RID.NavigationLink3D
- func (self Instance) ID() ID
- func (self Instance) NavigationLayers() int
- func (self Instance) SetBidirectional(value bool)
- func (self Instance) SetEnabled(value bool)
- func (self Instance) SetEndPosition(value Vector3.XYZ)
- func (self Instance) SetEnterCost(value Float.X)
- func (self Instance) SetGlobalEndPosition(position Vector3.XYZ)
- func (self Instance) SetGlobalStartPosition(position Vector3.XYZ)
- func (self Instance) SetNavigationLayerValue(layer_number int, value bool)
- func (self Instance) SetNavigationLayers(value int)
- func (self Instance) SetNavigationMap(navigation_map RID.NavigationMap3D)
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) SetStartPosition(value Vector3.XYZ)
- func (self Instance) SetTravelCost(value Float.X)
- func (self Instance) StartPosition() Vector3.XYZ
- func (self Instance) TravelCost() Float.X
- func (self *Instance) UnsafePointer() unsafe.Pointer
- func (self Instance) Virtual(name string) reflect.Value
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 Extension ¶
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]) AsNavigationLink3D ¶
type 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.
type Instance ¶
type Instance [1]gdclass.NavigationLink3D
A link between two positions on [NavigationRegion3D]s that agents can be routed through. These positions can be on the same [NavigationRegion3D] or on two different ones. Links are useful to express navigation methods other than traveling along the surface of the navigation mesh, such as ziplines, teleporters, or gaps that can be jumped across.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsNavigationLink3D ¶
func (Instance) Bidirectional ¶
func (Instance) EndPosition ¶
func (Instance) GetGlobalEndPosition ¶
Returns the [member end_position] that is relative to the link as a global position.
func (Instance) GetGlobalStartPosition ¶
Returns the [member start_position] that is relative to the link as a global position.
func (Instance) GetNavigationLayerValue ¶
Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [param layer_number] between 1 and 32.
func (Instance) GetNavigationMap ¶
func (self Instance) GetNavigationMap() RID.NavigationMap3D
Returns the current navigation map [RID] used by this link.
func (Instance) GetRid ¶
func (self Instance) GetRid() RID.NavigationLink3D
Returns the [RID] of this link on the [NavigationServer3D].
func (Instance) NavigationLayers ¶
func (Instance) SetBidirectional ¶
func (Instance) SetEnabled ¶
func (Instance) SetEndPosition ¶
func (Instance) SetEnterCost ¶
func (Instance) SetGlobalEndPosition ¶
Sets the [member end_position] that is relative to the link from a global [param position].
func (Instance) SetGlobalStartPosition ¶
Sets the [member start_position] that is relative to the link from a global [param position].
func (Instance) SetNavigationLayerValue ¶
Based on [param value], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [param layer_number] between 1 and 32.
func (Instance) SetNavigationLayers ¶
func (Instance) SetNavigationMap ¶
func (self Instance) SetNavigationMap(navigation_map RID.NavigationMap3D)
Sets the [RID] of the navigation map this link should use. By default the link will automatically join the [World3D] default navigation map so this function is only required to override the default map.
Source Files