Navigation¶
The alias Nav is more commonly used than Navigation.
Associated DataTypes¶
Navigation¶
- Contains information about current mesh, path, velocity, and settings.
-
Members
bool
Active¶- Returns true if navigation is currently active
bool
Paused¶- Returns true if navigation is currently paused
bool
MeshLoaded¶- Returns true if a mesh is loaded in the current zone
bool
PathExists[parameters]¶- Returns true if the specified navigation parameters results in a navigatable path. Navigation parameters are the same parameters that would be passed to /nav
nav to target if a path exists
/if ${Navigation.PathExists[target]} { /nav target }float
PathLength[parameters]¶- Similar to PathExists, but returns the length of the path if one is found. Navigation parameters are the same parameters that would be passed to /nav
int
Velocity¶- Returns current velocity of the player, rounded to nearest integer.
string
Setting[<key>]¶- Will return the string value of the setting
Example
/echo ${Navigation.Setting[OpenDoors]}
Examples¶
- The alias for this TLO, Nav, is commonly used.
/echo ${Nav.MeshLoaded}
This TLO is added by MQ2Nav.