Skip to main content

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.

Static Functions

ReturnsNameDescription
VectorGetRandomReachablePointInRadiusFinds random, reachable point in navigable space restricted to radius around origin
VectorGetRandomPointInNavigableRadiusFinds random, point in navigable space restricted to Radius around Origin. Resulting location is not tested for reachability from the Origin
tableFindPathToLocationFinds a Path given Start and End location

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)
TypeParameterDefaultDescription
Vectororigin
floatradius

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)
TypeParameterDefaultDescription
Vectororigin
floatradius

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)
TypeParameterDefaultDescription
Vectorstart_location
Vectorend_location

Events

This entity doesn't have own events.