diff --git a/alias.lua b/alias.lua index a152801..6e028ab 100644 --- a/alias.lua +++ b/alias.lua @@ -12,7 +12,9 @@ ---@alias MQCachedBuff cachedbuff | fun(): string|nil ---@alias MQCharacter character | fun(): string|nil ---@alias MQFellowship fellowship | fun(): "TRUE" | "FASLE" +---@alias MQGround ground | fun(): string|nil ---@alias MQGroupMember groupmember | fun(): string|nil +---@alias MQHeading heading | fun(): string|nil ---@alias MQInvSlot invslot | fun(): string|nil ---@alias MQItem item | fun(): string|nil ---@alias MQMerchant merchant | fun(): string|nil diff --git a/datatype/_character.lua b/datatype/_character.lua index cdf93ce..ead7d8b 100644 --- a/datatype/_character.lua +++ b/datatype/_character.lua @@ -205,11 +205,11 @@ function character.Ability(index) end ---@diagnostic disable: duplicate-set-field ---@param index integer # Ability button number ----@return boolean +---@return MQBoolean function character.AbilityReady(index) end ---@param name string ----@return boolean +---@return MQBoolean function character.AbilityReady(name) end ---@diagnostic enable: duplicate-set-field @@ -225,11 +225,11 @@ function character.AltAbility(name) end ---@diagnostic disable: duplicate-set-field ---@param index integer # Alt ability # ----@return boolean +---@return MQBoolean function character.AltAbilityReady(index) end ---@param name string ----@return boolean +---@return MQBoolean function character.AltAbilityReady(name) end ---@diagnostic enable: duplicate-set-field @@ -362,7 +362,7 @@ function character.Inventory(slotNumber) end ---@diagnostic enable: duplicate-set-field ---@param name string ----@return boolean # True/False on if the item is ready to cast. +---@return MQBoolean # True/False on if the item is ready to cast. function character.ItemReady(name) end ---@diagnostic disable: duplicate-set-field @@ -433,12 +433,12 @@ function character.Song(slotNumber) end ---@diagnostic disable: duplicate-set-field ---Gem with this spell name ready to cast? ---@param name string ----@return boolean +---@return MQBoolean function character.SpellReady(name) end ---Gem in this gem # ready to cast? ---@param slotNumber integer ----@return boolean +---@return MQBoolean function character.SpellReady(slotNumber) end ---@diagnostic enable: duplicate-set-field diff --git a/datatype/_ground.lua b/datatype/_ground.lua index 60f4644..6cd4e00 100644 --- a/datatype/_ground.lua +++ b/datatype/_ground.lua @@ -1,27 +1,26 @@ ---@meta ---@class ground ----@field public ID number Ground item ID (not the same as item ID, this is like spawn ID) ----@field public Distance number Distance from player to ground item ----@field public X MQFloat X coordinate ----@field public Y MQFloat Y coordinate ----@field public Z MQFloat Z coordinate ----@field public Heading heading Ground item is facing this heading ----@field public Name string Name ----@field public HeadingTo heading Direction player must move to meet this ground item ----@field public LineOfSight boolean Returns TRUE if ground spawn is in line of sight ----@field public Address number ??? ----@field public DisplayName MQFloat Displays name of the grounspawn ----@field public Distance3D number Distance from player to ground item ----@field public SubID number ??? ----@field public ZoneID number ??? ----@field public First MQSpawn ----@field public Last MQSpawn ----@field public Next MQSpawn ----@field public Prev MQSpawn ----@field public DoFace fun() Will cause the toon to face the called for spawn if it exists ----@field public DoTarget fun() Will cause the toon to target the called for spawn if it exists ----@field public Grab fun() Picks up the ground spawn ----@field public W MQFloat X coordinate (Westward-positive) ----@field public N MQFloat Y coordinate (Northward-positive) ----@field public U MQFloat Z coordinate (Upward-positive) ----@field public ToString string Same as ID \ No newline at end of file +---@field public ID MQInt # Ground item ID (not the same as item ID, this is like spawn ID) +---@field public Distance MQFloat # Distance from player to ground item +---@field public X MQFloat # X coordinate +---@field public Y MQFloat # Y coordinate +---@field public Z MQFloat # Z coordinate +---@field public Heading MQHeading # Ground item is facing this heading +---@field public Name MQString # Name +---@field public HeadingTo MQHeading # Direction player must move to meet this ground item +---@field public LineOfSight MQBoolean # Returns TRUE if ground spawn is in line of sight +---@field public DisplayName MQFloat # Displays name of the grounspawn +---@field public Distance3D MQFloat # Distance from player to ground item +---@field public SubID MQInt # ??? +---@field public ZoneID MQInt # ID of the zone +---@field public First MQGround +---@field public Last MQGround +---@field public Next MQGround +---@field public Prev MQGround +---@field public DoFace fun() # Will cause the toon to face the called for spawn if it exists +---@field public DoTarget fun() # Will cause the toon to target the called for spawn if it exists +---@field public Grab fun() # Picks up the ground spawn +---@field public W MQFloat # X coordinate (Westward-positive) +---@field public N MQFloat # Y coordinate (Northward-positive) +---@field public U MQFloat # Z coordinate (Upward-positive) +---@field public ToString MQString # Same as ID \ No newline at end of file diff --git a/datatype/_plugin.lua b/datatype/_plugin.lua index 04de8fe..9f29a69 100644 --- a/datatype/_plugin.lua +++ b/datatype/_plugin.lua @@ -1,4 +1,5 @@ --- @class plugin ---- @field public Name MQString #Name of the plugin ---- @field public Version MQFloat Version number of the plugin ---- @field public ToString MQString #Same as Name \ No newline at end of file +--- @field public Name MQString # Name of the plugin +--- @field public Version MQFloat # Version number of the plugin +--- @field public IsLoaded MQBoolean # Is the plugin loaded? +--- @field public ToString MQString # Same as Name diff --git a/mq.lua b/mq.lua index 1ac6b60..56e7760 100644 --- a/mq.lua +++ b/mq.lua @@ -3,6 +3,9 @@ ---@class Mq ---@field public TLO TLO # Top Level Object (TLO) Binding ---@field public imgui IMGUI # sol2 ImGui Binding +---@field public configDir string # Path to config directory +---@field public luaDir string # Path to lua directory +---@field public moduleDir string # Path to module directory mq = {} ---Performs an ingame slash action provided as a string. Any arguments passed to it are stringified (in lua), concatenated (with a space delimiter), and sent as part of the command. @@ -68,18 +71,6 @@ function mq.getAllSpawns() end ---@return spawn[] # The spawns function mq.getFilteredSpawns(predicate) end ----Returns path to config directory ----@return string # Path to config directory -function mq.configDir() end - ----Returns path to lua directory ----@return string # Path to lua directory -function mq.luaDir() end - ----Returns path to module directory ----@return string # Path to module directory -function mq.moduleDir() end - ---@param type any # The variable we want to check type of ---@return mqtype function mq.gettype(type) end diff --git a/tlo/_AdvLoot.lua b/tlo/_AdvLoot.lua index 8325dcb..189ac1f 100644 --- a/tlo/_AdvLoot.lua +++ b/tlo/_AdvLoot.lua @@ -1,9 +1,9 @@ ---@class AdvLoot ----@field public Filter fun(itemId:integer): itemfilterdata Inspect the loot filter for a given ItemID +---@field public Filter fun(itemId: integer): itemfilterdata Inspect the loot filter for a given ItemID ---@field public LootInProgress fun(): boolean True/False if looting from AdvLoot is in progress ---@field public PCount MQInt Item count from the Personal list ----@field public PList fun(index:integer): advlootitem Inspect the item at the specified index in the personal loot list +---@field public PList fun(index: integer): advlootitem Inspect the item at the specified index in the personal loot list ---@field public PWantCount MQInt Want cound from the personal list (AN + AG + ND + GD) ---@field public SCount MQInt Item count from the Shared list ----@field public SList fun(index:integer): advlootitem Inspect the item at the specified index in the shared loot list +---@field public SList fun(index: integer): advlootitem Inspect the item at the specified index in the shared loot list ---@field public SWantCount MQInt Want count from the Shared list (AN + AG + ND + GD) \ No newline at end of file diff --git a/tlo/_Ground.lua b/tlo/_Ground.lua index 4c7dbe2..1c98c22 100644 --- a/tlo/_Ground.lua +++ b/tlo/_Ground.lua @@ -2,4 +2,4 @@ ---Ground TLO ---@class Ground ----@field public Search fun(filter:string):ground +---@field public Search fun(filter: string): MQGround