🚢 Navigation
Creates a reachable path into navigable space.
🗿Static Class
This is a Static Class. Access it's methods directly with
.. It's not possible to spawn new instances.💂Authority
This static class can be accessed only on 🟧 Client side.
🧑💻API Source
This page is auto-generated! The Functions, Properties and Events described here are defined in our GitHub's API Repository! Feel free to commit suggestions and changes to the source .json API files!
🗿 Static Functions
| Returns | Name | Description | |
|---|---|---|---|
 | table | FindPathToLocation | Finds a Path given Start and End location |
| Vector | GetRandomPointInNavigableRadius | Finds random, point in navigable space restricted to Radius around Origin. Resulting location is not tested for reachability from the Origin |
| Vector | GetRandomReachablePointInRadius | Finds random, reachable point in navigable space restricted to radius around origin |
FindPathToLocation
Finds a Path given Start and End location (only if map has a NavMesh)
— Returns table (with this format).
local ret = Navigation.FindPathToLocation(start_location, end_location)
| Type | Parameter | Default | Description |
|---|---|---|---|
| Vector | start_location | Required parameter | No description provided |
| Vector | end_location | Required parameter | No description provided |
GetRandomPointInNavigableRadius
Finds random, point in navigable space restricted to Radius around Origin. Resulting location is not tested for reachability from the Origin (only if map has a NavMesh)
— Returns Vector (The random point).
local ret = Navigation.GetRandomPointInNavigableRadius(origin, radius)
| Type | Parameter | Default | Description |
|---|---|---|---|
| Vector | origin | Required parameter | No description provided |
| float | radius | Required parameter | No description provided |
GetRandomReachablePointInRadius
Finds random, reachable point in navigable space restricted to radius around origin (only if map has a NavMesh)
— Returns Vector (The random point).
local ret = Navigation.GetRandomReachablePointInRadius(origin, radius)
| Type | Parameter | Default | Description |
|---|---|---|---|
| Vector | origin | Required parameter | No description provided |
| float | radius | Required parameter | No description provided |