Skip to content

Commit

Permalink
Fix naviation definition
Browse files Browse the repository at this point in the history
  • Loading branch information
projecteon committed Sep 12, 2022
1 parent 16ab920 commit 579521f
Showing 1 changed file with 24 additions and 6 deletions.
30 changes: 24 additions & 6 deletions tlo/_Navigation.lua
Expand Up @@ -2,9 +2,27 @@

--- Navigation Lua Bindings
--- @class TLO.Navigation
--- @field public Active boolean Returns true if navigation is currently active
--- @field public Paused boolean Returns true if nativation is currently paused
--- @field public MeshLoaded boolean Returns true if a mesh is loaded for the zone
--- @field public PathExists boolean Returns true if a path exists for the target
--- @field public PathLength int
TLO.Navigation = {}
--- @field public Active fun(): boolean Returns true if navigation is currently active
--- @field public Paused fun(): boolean Returns true if nativation is currently paused
--- @field public MeshLoaded fun(): boolean Returns true if a mesh is loaded for the zone
TLO.Navigation = {}

----Returns true if a path exists for the target
---@param navigationParams string # Navigation parameters are the same parameters that would be passed to /nav
---@return boolean # Can navigate to the given [navigationParams]
function TLO.Navigation.PathExists(navigationParams) end

----Returns true if a path exists for the target
---@param target target
---@return boolean # Can navigate to the given [target]
function TLO.Navigation.PathExists(target) end

----Returns the length of the path if one is found
---@param navigationParams string # Navigation parameters are the same parameters that would be passed to /nav
---@return integer # Length of the path if one is found given [navigationParams]
function TLO.Navigation.PathLength(navigationParams) end

----Returns the length of the path if one is found
---@param target target
---@return integer # Length of the path if one is found given [target]
function TLO.Navigation.PathLength(target) end

0 comments on commit 579521f

Please sign in to comment.