Skip to content

Commit

Permalink
Added and corrected a few datatype members. (#85)
Browse files Browse the repository at this point in the history
* Added PortalSetter TLO and Members

* Added Toggle

* Added Present

* Renamed DoLeftCLick to LeftClick. Added RightClick. Changed FindBuff from MQSpell to MQBuff

* Added Origin zone object to character datatype
  • Loading branch information
yb-f authored Jun 23, 2024
1 parent e46667f commit 2d4066f
Show file tree
Hide file tree
Showing 5 changed files with 68 additions and 33 deletions.
87 changes: 56 additions & 31 deletions mq/datatype/_character.lua
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,7 @@
---@field public Name MQString #First name
---@field public NumGems MQFloat #Returns the amount of spell gems your toon has
---@field public NumBagSlots MQInt #Returns the total number of bag slots
---@field public Origin MQZone # Returns character home city zone
---@field public Orux MQFloat #Orux on your character
---@field public PctAAExp MQFloat #AA exp as a %
---@field public PctAAVitality MQFloat #Percentage of AA Vitality your toon has
Expand Down Expand Up @@ -215,46 +216,51 @@ function character.Ability(name) end
---@param index integer|string # doability button number
---@return string # The skill name assigned to this doability button
function character.Ability(index) end

---@diagnostic enable: duplicate-set-field

---@diagnostic disable: duplicate-set-field
---@param index integer|string # Ability button number
---@return MQBoolean
function character.AbilityReady(index) end

---@param name string
---@param name string
---@return MQBoolean
function character.AbilityReady(name) end

---@diagnostic enable: duplicate-set-field

---@diagnostic disable: duplicate-set-field
---@param index integer|string # Alt ability #
---@return altability
function character.AltAbility(index) end

---@param name string
---@param name string
---@return altability
function character.AltAbility(name) end

---@diagnostic enable: duplicate-set-field

---@diagnostic disable: duplicate-set-field
---@param index integer|string # Alt ability #
---@return MQBoolean
function character.AltAbilityReady(index) end

---@param name string
---@param name string
---@return MQBoolean
function character.AltAbilityReady(name) end

---@diagnostic enable: duplicate-set-field

---@diagnostic disable: duplicate-set-field
---@param index integer|string # Alt ability #
---@return timestamp
function character.AltAbilityTimer(index) end

---@param name string
---@param name string
---@return timestamp
function character.AltAbilityTimer(name) end

---@diagnostic enable: duplicate-set-field

---@diagnostic disable: duplicate-set-field
Expand All @@ -265,6 +271,7 @@ function character.AbilityTimer(index) end
---@param name string
---@return timestamp
function character.AbilityTimer(name) end

---@diagnostic enable: duplicate-set-field

---@diagnostic disable: duplicate-set-field
Expand All @@ -278,7 +285,7 @@ function character.AbilityTimerTotal(name) end

---@diagnostic enable: duplicate-set-field

---@param name string
---@param name string
---@return integer
function character.AltCurrency(name) end

Expand All @@ -290,19 +297,21 @@ function character.Aura(index) end
---@param name string # The aura name to check for
---@return MQSpell # The aura spell object for the given name
function character.Aura(name) end

---@diagnostic enable: duplicate-set-field

---@diagnostic disable: duplicate-set-field
---@param index integer|string # Bandolier undex 1:20
---@return bandolier
function character.Bandolier (index) end
function character.Bandolier(index) end

---@param bandolierName string # Bandolier Name
---@return bandolier
function character.Bandolier(bandolierName) end

---@diagnostic enable: duplicate-set-field

---@param slot integer # Bankslot number
---@param slot integer # Bankslot number
---@return MQItem
function character.Bank(slot) end

Expand All @@ -326,19 +335,21 @@ function character.BlockedPetBuff(slotNumber) end
---@param spellName string # Spell Name
---@return spell
function character.BlockedPetBuff(spellName) end

---@diagnostic enable: duplicate-set-field

---@diagnostic disable: duplicate-set-field
---@param name string
---@param name string
---@return integer # Slot in your spell book assigned to spell name
function character.Book(name) end

---@param slot integer # Slot number in book
---@param slot integer # Slot number in book
---@return spell
function character.Book(slot) end

---@diagnostic enable: duplicate-set-field

---@param bindPointIndex integer # Your bind points (0-4)
---@param bindPointIndex integer # Your bind points (0-4)
---@return worldlocation
function character.BoundLocation(bindPointIndex) end

Expand All @@ -350,6 +361,7 @@ function character.Buff(name) end
---@param slotNumber integer|string # Buff slot number
---@return MQBuff
function character.Buff(slotNumber) end

---@diagnostic enable: duplicate-set-field

---@diagnostic disable: duplicate-set-field
Expand All @@ -359,9 +371,10 @@ function character.Buff(slotNumber) end
function character.CombatAbility(name) end

---The name of Combat Ability # in your list (not the same as anyone else's list!)
---@param index integer|string # Combat Ability # in your list
---@param index integer|string # Combat Ability # in your list
---@return MQSpell
function character.CombatAbility(index) end

---@diagnostic enable: duplicate-set-field

---@diagnostic disable: duplicate-set-field
Expand All @@ -374,19 +387,21 @@ function character.CombatAbilityReady(index) end
---@param name string
---@return boolean
function character.CombatAbilityReady(name) end

---@diagnostic enable: duplicate-set-field

---@diagnostic disable: duplicate-set-field
---@param index integer|string # Combat ability #
---@return ticks
function character.CombatAbilityTimer(index) end

---@param name string
---@param name string
---@return ticks
function character.CombatAbilityTimer(name) end

---@diagnostic enable: duplicate-set-field

---@param minSize? integer|string # spaces of at least [minSize] size (giant=4)
---@param minSize? integer|string # spaces of at least [minSize] size (giant=4)
---@return integer # Number of free inventory spaces
function character.FreeInventory(minSize) end

Expand All @@ -395,19 +410,21 @@ function character.FreeInventory(minSize) end
---@return integer # Returns the slot # with the spell name
function character.Gem(name) end

---@param gemSlot integer
---@param gemSlot integer
---@return MQSpell
function character.Gem(gemSlot) end

---@diagnostic enable: duplicate-set-field

---@diagnostic disable: duplicate-set-field
---@param name string # Spell name
---@return ticks
function character.GemTimer(name) end

---@param gemSlot integer
---@param gemSlot integer
---@return ticks
function character.GemTimer(gemSlot) end

---@diagnostic enable: duplicate-set-field

---@param index integer # Current group marked NPC (1-3)
Expand All @@ -423,23 +440,25 @@ function character.HaveExpansion(expansionNumber) end
---@return MQItem
function character.Inventory(name) end

---@param slotNumber integer
---@param slotNumber integer
---@return MQItem
function character.Inventory(slotNumber) end

---@diagnostic enable: duplicate-set-field

---@param name string
---@param name string
---@return MQBoolean # True/False on if the item is ready to cast.
function character.ItemReady(name) end

---@diagnostic disable: duplicate-set-field
---@param name string
---@param name string
---@return integer # langauge number
function character.Language(name) end

---@param languageNumber integer
---@param languageNumber integer
---@return string # The EQ language name of the language number specified.
function character.Language(languageNumber) end

---@diagnostic enable: duplicate-set-field

---@param language string|integer
Expand All @@ -454,6 +473,7 @@ function character.PetBuff(name) end
---@param slotNumber integer # PetBuff slot number
---@return MQBuff
function character.PetBuff(slotNumber) end

---@diagnostic enable: duplicate-set-field

---@return spawn
Expand All @@ -468,45 +488,49 @@ function character.RaidAssistTarget(index) end
function character.RaidMarkNPC(index) end

---@diagnostic disable: duplicate-set-field
---@param name string
---@param name string
---@return integer # Returns current skill level
function character.Skill(name) end

---@param skillId integer|string
---@param skillId integer|string
---@return integer # Returns current skill level
function character.Skill(skillId) end

---@diagnostic enable: duplicate-set-field

---@diagnostic disable: duplicate-set-field
---@param name string
---@return integer
---@param name string
---@return integer
function character.SkillCap(name) end

---@param skillId integer|string
---@param skillId integer|string
---@return integer
function character.SkillCap(skillId) end

---@diagnostic enable: duplicate-set-field

---@diagnostic disable: duplicate-set-field
---@param name string
---@return MQBuff
---@param name string
---@return MQBuff
function character.Song(name) end

---@param slotNumber integer|string
---@param slotNumber integer|string
---@return MQBuff
function character.Song(slotNumber) end

---@diagnostic enable: duplicate-set-field

---@diagnostic disable: duplicate-set-field
---Gem with this spell name ready to cast?
---@param name string
---@return MQBoolean
---@param name string
---@return MQBoolean
function character.SpellReady(name) end

---Gem in this gem # ready to cast?
---@param slotNumber integer|string
---@param slotNumber integer|string
---@return MQBoolean
function character.SpellReady(slotNumber) end

---@diagnostic enable: duplicate-set-field

---Returns the number of AUTO-HATER mobs on the extended target window where your aggro is less than the optional parameter N. N must be between 1-100 inclusive or it will be set to 100 (the default value).
Expand All @@ -520,9 +544,10 @@ function character.XTAggroCount(n) end
function character.XTarget() end

---Extended target data for the specified XTarget #.
---@param index integer|string
---@param index integer|string
---@return xtarget
function character.XTarget(index) end

---@diagnostic enable: duplicate-set-field

---Returns the Long Name of the zone you are bound inactive
Expand Down
1 change: 1 addition & 0 deletions mq/datatype/_group.lua
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
--- @field public MouseOver MQString # Returns the name of the group member your mouse is hovering over
--- @field public Offline MQBoolean # Will return a TRUE if offline, and FALSE if online
--- @field public OtherZone MQBoolean # Will return a Bool TRUE if online but in another zone and FALSE if online and in same zone as you.
--- @field public Present MQInt # Number of group members present in zone (not including you)
--- @field public Puller MQGroupMember # Data on the puller of the group
--- @field public TankMercCount MQFloat # Count of how many Tank mercenaries are in your group
--- @field public ToString MQString # Same as Members
Expand Down
5 changes: 3 additions & 2 deletions mq/datatype/_spawn.lua
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@
---@field public LastCastNum MQFloat # No idea...
---@field public LastCastTime MQFloat # No idea...
---@field public Level MQFloat # Level
---@field public DoLeftClick fun() # Left clicks the spawn
---@field public LeftClick fun() # Left clicks the spawn
---@field public Levitating MQBoolean # Levitating?
---@field public LFG MQBoolean # LFG?
---@field public Light MQString # Name of the light class this spawn has
Expand Down Expand Up @@ -127,6 +127,7 @@
---@field public Primary MQFloat # Item ID of anything that may be in the Primary slot
---@field public pTouchingSwitch MQFloat # Have no idea what this is...
---@field public Race race Race
---@field public RightClick fun() # Right clicks the spawn
---@field public Roleplaying MQBoolean # Roleplaying?
---@field public Secondary MQFloat # Item ID of anything that may be in the Secondary slot
---@field public SeeInvis MQFloat
Expand Down Expand Up @@ -157,7 +158,7 @@
---@field public E MQFloat # Shortcut for -X (makes Eastward positive)
---@field public S MQFloat # Shortcut for -Y (makes Southward positive)
---@field public D MQFloat # Shortcut for -Z (makes Downward positive)
---@field public FindBuff fun(predicate: string): MQSpell # Try find a given buff/debuff given predicate from cachedbuffs
---@field public FindBuff fun(predicate: string): MQBuff # Try find a given buff/debuff given predicate from cachedbuffs
---@field public Aggressive MQBoolean # Is the spawn aggressive towards you
local spawn = {}

Expand Down
1 change: 1 addition & 0 deletions mq/datatype/_switch.lua
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
--- @field public N MQFloat Y coordinate (Northward-positive)
--- @field public Name string Name
--- @field public Open boolean Open?
--- @field public Toggle fun() Toggles the selected switch
--- @field public ToString string Same as ID
--- @field public W MQFloat X coordinate (Westward-positive)
--- @field public X MQFloat X coordinate
Expand Down
7 changes: 7 additions & 0 deletions mq/tlo/_PortalSetter.lua
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---@meta

--- Navigation Lua Bindings
--- @class TLO.PortalSetter
--- @field public InProgress MQBoolean #Returns true if PortalSetting is in progress
--- @field public Step number #Returns step of the PortalSetter process
TLO.PortalSetter = {}

0 comments on commit 2d4066f

Please sign in to comment.