๐ข 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)
local ret = Navigation.FindPathToLocation(start_location, end_location)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| Vector | start_location | Required parameter | No description provided |
| Vector | end_location | Required parameter | No description provided |
Returns
| Type | Description |
|---|---|
| table | with this format |
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)
local ret = Navigation.GetRandomPointInNavigableRadius(origin, radius)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| Vector | origin | Required parameter | No description provided |
| float | radius | Required parameter | No description provided |
Returns
| Type | Description |
|---|---|
| Vector | The random point |
GetRandomReachablePointInRadiusโ
Finds random, reachable point in navigable space restricted to radius around origin (only if map has a NavMesh)
local ret = Navigation.GetRandomReachablePointInRadius(origin, radius)
Parameters
| Type | Parameter | Default | Description |
|---|---|---|---|
| Vector | origin | Required parameter | No description provided |
| float | radius | Required parameter | No description provided |
Returns
| Type | Description |
|---|---|
| Vector | The random point |
๐ย Eventsโ
This class doesn't have own events.