C_Navigation
namespaceavailable in: camelotStatus in wowlua
7 functions: 1 implemented, 1 recorded, 5 guessed. 3 events, 2 of them fired by the emulator on its own.
Functions
| function | what it does | status |
|---|---|---|
GetDistance | Returns the distance in yards from the players current location to the tracked location.(): number | guessed |
GetFrame | Returns the UI frame positioned in the world for displaying the tracked location, if one has been created.(): ScriptRegion? | recorded |
GetNearestPartyMemberToken | Returns the unit token of the nearest party member. · by wowlua(): string | guessed |
GetNextWaypointForMap | Returns the next navigation waypoint on a map. · by wowlua(uiMapID: number): (number?, number?, string?) | implemented |
GetTargetState | Returns state information about the currently tracked location, such as its occlusion status.(): NavigationState | guessed |
HasValidScreenPosition | Returns true if the currently tracked location can be represented by any screen position. This can presumably return false a tracked location weren't valid for the current map, or if the player is possibly too close to a tracked location.(): boolean | guessed |
WasClampedToScreen | Returns true if the navigation frame position was clamped due to having been located off-screen. This can indicate that the player may not be facing towards the tracked location.(): boolean | guessed |
"by wowlua": no one documents this function, so wowlua wrote the description from its name, signature and behaviour.
Events
| event | payload | fired by the emulator |
|---|---|---|
NAVIGATION_DESTINATION_REACHED | isWaypoint: boolean | not implemented |
NAVIGATION_FRAME_CREATED | region: ScriptRegion | implemented |
NAVIGATION_FRAME_DESTROYED | no payload | implemented |
An event the emulator doesn't fire on its own can still be fired from a test: mock.fireEvent("NAVIGATION_DESTINATION_REACHED").
sources
Signatures, events and structures: Blizzard's API documentation (Blizzard_APIDocumentationGenerated) (InGameNavigation system, camelot 1.60.1). Descriptions: warcraft.wiki.gg's API pages, by its contributors, CC BY-SA 4.0 ↗; written by wowlua where no documentation describes the entry.