Skip to content

Commit

Permalink
Need to have TLO global to have plugin types show class variables.
Browse files Browse the repository at this point in the history
Report bug on this.
  • Loading branch information
projecteon committed Sep 12, 2022
1 parent 5e8d3e4 commit 49a33a9
Show file tree
Hide file tree
Showing 6 changed files with 20 additions and 20 deletions.
2 changes: 1 addition & 1 deletion mq.lua
Expand Up @@ -152,7 +152,7 @@ function mq.imgui.destory(name) end
---@field Time time
---@field Type fun(type: string): type #Information on data types
---@field Window fun(name: string): window #Information on a particular UI window
local TLO = {}
TLO = {}

---@diagnostic disable: duplicate-set-field
---Returns a pipe | separated list of alert ids
Expand Down
4 changes: 2 additions & 2 deletions plugins/EQBC/_TLO.lua
@@ -1,11 +1,11 @@
---@meta

--- EQBC Lua Bindings
---@class mq.TLO.EQBC
---@class TLO.EQBC
---@field Connected fun(): boolean Client connection status
---@field Names fun(): string List of connected characters (space delmited)
---@field Port fun(): string OFFLINE if not connected, port if connected
---@field Server fun(): string Hostname or IP of server you connected to
---@field ToonName fun(): string Character name as seen by EQBC \(may reflect YouPlayer\)
---@field Setting fun(): boolean Option enabled/disabled status. \(see **/bccmd set** for complete list\)
mq.TLO.EQBC = {}
TLO.EQBC = {}
20 changes: 10 additions & 10 deletions plugins/MoveUtils/_TLO.lua
@@ -1,7 +1,7 @@
---@meta

--- MoveUtils Lua Bindings
---@class mq.TLO.MoveUtils
---@class TLO.MoveUtils
---@field Command fun(): string Returns the currently active command. MAKECAMP returns if a camp is setup but no other command is currently in use ["NONE", "STICK", "MOVETO", "MAKECAMP", "CIRCLE"]
---@field Stuck fun(): boolean Returns true if plugin stucklogic has determined you are currently stuck
---@field Summoned fun(): boolean Returns true if BreakOnSummon is enabled and has fired due to your character being summoned beyond breakonsummon distance
Expand All @@ -19,10 +19,10 @@
---@field Version fun(): number Returns the version number of the plugin
---@field MovePause fun(): boolean Returns TRUE if mpause \(PauseKB\) is enabled
---@field GM fun(): boolean Returns TRUE if BreakOnGM fired
mq.TLO.MoveUtils = {}
TLO.MoveUtils = {}

--- Stick Lua Bindings
---@class mq.Stick
---@class Stick
---@field Status fun(): string Returns ON if any form of stick is active ["OFF", "PAUSED" or "ON"]
---@field Active fun(): boolean Returns TRUE if any form of stick is active
---@field Broken fun(): boolean Returns TRUE if BreakOnHit event has halted stick prematurely
Expand All @@ -39,10 +39,10 @@ mq.TLO.MoveUtils = {}
---@field DistMod fun(): number Returns current stickdist modifier
---@field DistModPercent fun(): number Returns current stickdist percent modifier
---@field Always fun(): boolean Returns TRUE if /stick always is active
mq.TLO.Stick = {}
TLO.Stick = {}

--- MoveTo Lua Bindings
---@class mq.TLO.MoveTo
---@class TLO.MoveTo
---@field Moving fun(): boolean Returns TRUE if moveto or camp return is active
---@field Stopped fun(): boolean Returns TRUE if the last moveto command completed successfully
---@field CampStopped fun(): boolean Returns TRUE if within moveto distance of makecamp Y X location
Expand All @@ -51,10 +51,10 @@ mq.TLO.Stick = {}
---@field ArrivalDistY fun(): number Returns acceptable arrival distance for precisey
---@field ArrivalDistX fun(): number Returns acceptable arrival distance for precisex
---@field Broken fun(): boolean Returns TRUE if BreakOnAggro or BreakOnHit event have halted moveto prematurely
mq.TLO.MoveTo = {}
TLO.MoveTo = {}

--- MakeCamp Lua Bindings
---@class mq.TLO.MakeCamp
---@class TLO.MakeCamp
---@field Status fun(): string Returns status of MakeCamp command. AltCamp returns OFF ["OFF", "PAUSED" or "ON"]
---@field Leash fun(): boolean Returns TRUE if plugin stucklogic has determined you are currently stuck
---@field AnchorX fun(): number Returns location of current camp X anchor
Expand All @@ -76,10 +76,10 @@ mq.TLO.MoveTo = {}
---@field Bearing fun(): number Returns the bearing \(heading\) of camp scattering
---@field ScatDist fun(): number Returns the distance from anchor to perform scatter
---@field ScatSize fun(): number Returns the size of scattering radius
mq.TLO.MakeCamp = {}
TLO.MakeCamp = {}

--- Circle Lua Bindings
---@class mq.TLO.Circle
---@class TLO.Circle
---@field Status fun(): string Returns ON if circling ["OFF", "PAUSED" or "ON"]
---@field CircleY fun(): number Returns the location of circle center Y
---@field CircleX fun(): number Returns the location of circle center X
Expand All @@ -89,4 +89,4 @@ mq.TLO.MakeCamp = {}
---@field Clockwise fun(): boolean Returns FALSE if reverse circling
---@field Backwards fun(): boolean Returns TRUE if movement direction backwards
---@field Radius fun(): number Returns the radius size of circle
mq.TLO.Circle = {}
TLO.Circle = {}
6 changes: 3 additions & 3 deletions plugins/NetBots/_TLO.lua
@@ -1,14 +1,14 @@
---@meta

--- NetBots Lua Bindings
---@class mq.TLO.NetBots
---@class TLO.NetBots
---@field Client fun(index: integer): netbot The netbot at the given index in the array
---@field Counts fun(): integer The number of connected clients.
---@field Enable fun(): boolean The plugin status.
---@field Listen fun(): boolean The grab parameter status.
---@field Output fun(): boolean The send parameter status.
mq.TLO.NetBots = {}
TLO.NetBots = {}

---@param name string # Name of he netbot
---@return netbot|"NULL" # Returns the netbot with the given name or 'NULL' if not found
function mq.TLO.NetBots(name) end
function TLO.NetBots(name) end
4 changes: 2 additions & 2 deletions plugins/Twist/_TLO.lua
@@ -1,9 +1,9 @@
---@meta

--- Twist Lua Bindings
---@class mq.TLO.Twist
---@class TLO.Twist
---@field Twisting fun(): boolean Returns TRUE if currently twisting, FALSE if not and NULL if plugin not loaded.
---@field Current fun(): integer Returns the current gem being sung, -1 for item or 0 if not twisting
---@field Next fun(): integer Returns the next gem to be sung, -1 for item or 0 if not twisting
---@field List fun(): string Returns the twist sequence in a format suitable for /twist.
mq.TLO.Twist = {}
TLO.Twist = {}
4 changes: 2 additions & 2 deletions tlo/_Navigation.lua
@@ -1,10 +1,10 @@
---@meta

--- Navigation Lua Bindings
--- @class mq.TLO.Navigation
--- @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
mq.TLO.Navigation = {}
TLO.Navigation = {}

0 comments on commit 49a33a9

Please sign in to comment.