DataType:Navigation

From the wonderful RedGuides Wiki

Contains information about current mesh, path, velocity, and settings.


This Data Type is referenced in MQ2Nav, and accessed by Top-Level Object(s): Navigation

Members

Type Member Description
bool Active Returns true if navigation is currently active
MeshLoaded Returns true if a mesh is loaded in the current zone
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, see example below.
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.
Paused Returns true if navigation is currently paused
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

Nav to target if a path exists (in macro script),

/if ${Navigation.PathExists[target]} {
        /nav target
    }

See also