Struct Navigation2D
2D navigation and pathfinding node.
struct Navigation2D
;
Navigation2D provides navigation and pathfinding within a 2D area, specified as a collection of NavigationPolygon resources. By default, these are automatically collected from child NavigationPolygonInstance nodes, but they can also be added on the fly with navpolyAdd.
Methods
| Name | Description |
|---|---|
getClosestPoint
|
Returns the navigation point closest to the point given. Points are in local coordinate space. |
getClosestPointOwner
|
Returns the owner of the NavigationPolygon which contains the navigation point closest to the point given. This is usually a NavigationPolygonInstance. For polygons added via navpolyAdd, returns the owner that was given (or null if the owner parameter was omitted).
|
getSimplePath
|
Returns the path between two given points. Points are in local coordinate space. If optimize is true (the default), the path is smoothed by merging path segments where possible.
|
navpolyAdd
|
Adds a NavigationPolygon. Returns an ID for use with navpolyRemove or navpolySetTransform. If given, a Transform2D is applied to the polygon. The optional owner is used as return value for getClosestPointOwner.
|
navpolyRemove
|
Removes the NavigationPolygon with the given ID.
|
navpolySetTransform
|
Sets the transform applied to the NavigationPolygon with the given ID.
|