diff --git a/README.md b/README.md index 9efef1a..a9647f8 100644 --- a/README.md +++ b/README.md @@ -14,3 +14,13 @@ The files in this library work with the VSCode Extension found here: - [VSCode Marketplace - Lua Language Server Extension](https://marketplace.visualstudio.com/items?itemName=sumneko.lua) The extension can also be installed directly from within VSCode. Search Extensions for "Lua Language Server" as seen here, and install the one by "sumneko" ![image](https://user-images.githubusercontent.com/414568/189777359-887c937a-5453-4ea0-a8f0-5c41ea4d6b66.png) +- Create a [settings file for VS Code](https://code.visualstudio.com/docs/getstarted/settings#_workspace-settingsjson-location) if you do not already have one with these settings: +```json +{ + "Lua.runtime.version": "Lua 5.1", + "Lua.workspace.library": [ + "./relative/path/to/mq/def", + "./relative/path/to/imgui/def" + ], +} +``` diff --git a/datatype/_altability.lua b/datatype/_altability.lua index e70e5ea..a94ff46 100644 --- a/datatype/_altability.lua +++ b/datatype/_altability.lua @@ -1,21 +1,21 @@ --- @class altability ---- @field public AARankRequired number Rank required to train ---- @field public CanTrain boolean Returns true/false on if the Alternative Ability can be trained ---- @field public Cost number Base cost to train ---- @field public Description string Basic description ---- @field public ID number ID ---- @field public Index number Returns the index number of the Alternative Ability ---- @field public MaxRank number Max rank available in this ability ---- @field public MinLevel number Minimum level to train ---- @field public MyReuseTime number Reuse time with any hastened AA abilties ---- @field public Name string Name ---- @field public NextIndex number Returns the next index number of the Alternative Ability ---- @field public PointsSpent number Returns the amount of points spent on an AA ---- @field public Passive boolean Returns true/false on if the Alternative Ability is passive +--- @field public AARankRequired fun(): number Rank required to train +--- @field public CanTrain fun(): boolean Returns true/false on if the Alternative Ability can be trained +--- @field public Cost fun(): number Base cost to train +--- @field public Description fun(): string Basic description +--- @field public ID fun(): integer ID +--- @field public Index fun(): number Returns the index number of the Alternative Ability +--- @field public MaxRank fun(): number Max rank available in this ability +--- @field public MinLevel fun(): number Minimum level to train +--- @field public MyReuseTime fun(): number Reuse time with any hastened AA abilties +--- @field public Name fun(): string Name +--- @field public NextIndex fun(): number Returns the next index number of the Alternative Ability +--- @field public PointsSpent fun(): number Returns the amount of points spent on an AA +--- @field public Passive fun(): boolean Returns true/false on if the Alternative Ability is passive --- @field public RequiresAbility altability Required ability (if any) ---- @field public Rank number Returns the Rank of the AA ---- @field public RequiresAbilityPoints number Points required in above ability ---- @field public ReuseTime number Reuse time in seconds ---- @field public ShortName string Short name +--- @field public Rank fun(): number Returns the Rank of the AA +--- @field public RequiresAbilityPoints fun(): number Points required in above ability +--- @field public ReuseTime fun(): number Reuse time in seconds +--- @field public ShortName fun(): string Short name --- @field public Spell spell Spell used by the ability (if any) ---- @field public Type number Type (1-6) \ No newline at end of file +--- @field public Type fun(): number Type (1-6) \ No newline at end of file diff --git a/datatype/_buff.lua b/datatype/_buff.lua index 8ec54d5..57f9909 100644 --- a/datatype/_buff.lua +++ b/datatype/_buff.lua @@ -1,10 +1,10 @@ --- @class buff ---- @field public Counters number The number of counters added by the buff ---- @field public Dar number The remaining damage absorption of the buff (if any). This is not entirely accurate, it will only show you to the Dar of your spell when it was initially cast, or what it was when you last zoned (whichever is more recent). +--- @field public Counters fun(): number The number of counters added by the buff +--- @field public Dar fun(): number The remaining damage absorption of the buff (if any). This is not entirely accurate, it will only show you to the Dar of your spell when it was initially cast, or what it was when you last zoned (whichever is more recent). --- @field public Duration ticks The time remaining before the buff fades (not total duration) ---- @field public ID number The ID of the buff or shortbuff slot ---- @field public Level number The level of the person that cast the buff on you (not the level of the spell) +--- @field public ID fun(): integer The ID of the buff or shortbuff slot +--- @field public Level fun(): number The level of the person that cast the buff on you (not the level of the spell) --- @field public Mod float The modifier to a bard song --- @field public Remove fun() Removes the named/partial name buff --- @field public Spell spell The spell ---- @field public ToString string Same as Name \ No newline at end of file +--- @field public ToString fun(): string Same as Name \ No newline at end of file diff --git a/datatype/_cachedBuff.lua b/datatype/_cachedBuff.lua index 7809f14..a36d035 100644 --- a/datatype/_cachedBuff.lua +++ b/datatype/_cachedBuff.lua @@ -4,8 +4,8 @@ --- --- Usagei --- @class cachedbuff ---- @field public CasterName string Returns the name of the caster who applied the cached buff ---- @field public Count number Returns the amount of buffs catched, or -1 it none ---- @field public Duration number Returns the duration of the cached buff ---- @field public Slot number Returns the buff slot the target had the buff in ---- @field public SpellID number Returns the buff's spell ID \ No newline at end of file +--- @field public CasterName fun(): string Returns the name of the caster who applied the cached buff +--- @field public Count fun(): number Returns the amount of buffs catched, or -1 it none +--- @field public Duration fun(): number Returns the duration of the cached buff +--- @field public Slot fun(): number Returns the buff slot the target had the buff in +--- @field public SpellID fun(): number Returns the buff's spell ID \ No newline at end of file diff --git a/datatype/_character.lua b/datatype/_character.lua index 4b888ab..a85f31f 100644 --- a/datatype/_character.lua +++ b/datatype/_character.lua @@ -1,213 +1,213 @@ ---@class character : spawn ---- @field public AAExp number AA exp as a raw number out of 10,000 (10,000=100%) ---- @field public AAPoints number Unused AA points ---- @field public AAPointsSpent number The number of points you have spent on AA abilities ---- @field public AAPointsTotal number The total number of AA points you have ---- @field public AAVitality number The total number of AA Vitality you have ---- @field public Ability string Skill name assigned to this doability button ---- @field public AbilityReady boolean Ability with this name or on this button # ready? ---- @field public AccuracyBonus number Accuracy bonus from gear and spells +--- @field public AAExp fun(): number AA exp as a raw number out of 10,000 (10,000=100%) +--- @field public AAPoints fun(): number Unused AA points +--- @field public AAPointsSpent fun(): number The number of points you have spent on AA abilities +--- @field public AAPointsTotal fun(): number The total number of AA points you have +--- @field public AAVitality fun(): number The total number of AA Vitality you have +--- @field public Ability fun(): string Skill name assigned to this doability button +--- @field public AbilityReady fun(): boolean Ability with this name or on this button # ready? +--- @field public AccuracyBonus fun(): number Accuracy bonus from gear and spells --- @field public ActiveDisc spell Returns a spell if melee discipline is active. ---- @field public ActiveFavorCost number If Tribute is active, how much it is costing you every 10 minutes. Returns NULL if tribute is inactive. +--- @field public ActiveFavorCost fun(): number If Tribute is active, how much it is costing you every 10 minutes. Returns NULL if tribute is inactive. --- @field public AltAbility altability Returns the total number of points you have spent in ability # or name ---- @field public AltAbilityReady boolean Alt ability # or name ready? ---- @field public AltAbilityTimer number Alt ability reuse time remaining (in ticks) for ability # or name ---- @field public AltTimerReady boolean Alternate timer ready? (Bash/Slam/Frenzy/Backstab). Note: ${AbilityReady} works fine with most of these. ---- @field public AGI number Character Agility +--- @field public AltAbilityReady fun(): boolean Alt ability # or name ready? +--- @field public AltAbilityTimer fun(): number Alt ability reuse time remaining (in ticks) for ability # or name +--- @field public AltTimerReady fun(): boolean Alternate timer ready? (Bash/Slam/Frenzy/Backstab). Note: ${AbilityReady} works fine with most of these. +--- @field public AGI fun(): number Character Agility --- @field public AggroLock spawn spawn info for aggro lock player ---- @field public AmIGroupLeader boolean Am I the group leader? ---- @field public AssistComplete boolean returns true/false if the assist is complete ---- @field public AttackBonus number Attack bonus from gear and spells ---- @field public AttackSpeed number Your Attack Speed. No haste spells/items = AttackSpeed of 100. A 41% haste item will result in an AttackSpeed of 141. This variable does not take into account spell or song haste. ---- @field public Aura string The aura effect name ---- @field public AutoFire boolean Is Autofire on? ---- @field public AvoidanceBonus number Avoidance bonus from gear/spells +--- @field public AmIGroupLeader fun(): boolean Am I the group leader? +--- @field public AssistComplete fun(): boolean returns true/false if the assist is complete +--- @field public AttackBonus fun(): number Attack bonus from gear and spells +--- @field public AttackSpeed fun(): number Your Attack Speed. No haste spells/items = AttackSpeed of 100. A 41% haste item will result in an AttackSpeed of 141. This variable does not take into account spell or song haste. +--- @field public Aura fun(): string The aura effect name +--- @field public AutoFire fun(): boolean Is Autofire on? +--- @field public AvoidanceBonus fun(): number Avoidance bonus from gear/spells --- @field public Bank item Item in this bankslot # ---- @field public BardSongPlaying boolean Is a bard song playing? ---- @field public Book number Slot in your spellbook assigned to spell name. +--- @field public BardSongPlaying fun(): boolean Is a bard song playing? +--- @field public Book fun(): number Slot in your spellbook assigned to spell name. --- @field public Buff buff The buff with this name ---- @field public Buyer boolean if you are an active buyer ---- @field public CanMount boolean for some indoor zones that where not flagged as nomount and added bazaar, nexus to zones where its ok to mount. ---- @field public CareerFavor number Career favor/tribute ---- @field public Cash number Total cash on your character, expressed in coppers (eg. if you are carrying 100pp, Cash will return 100000) ---- @field public CashBank number Total cash in your bank, expressed in coppers ---- @field public CHA number Character Charisma ---- @field public Chronobines number Chronobines on your character ---- @field public ClairvoyanceBonus number Clairvoyance Bonus ---- @field public Combat boolean In combat? ---- @field public CombatAbility number The number of Combat ability name in your list (not the same as anyone else's list!) ---- @field public CombatAbilityReady boolean Is this Combat Ability ready? ---- @field public CombatAbilityTimer number The time remaining (in seconds) before the Combat Ability name is usable ---- @field public CombatEffectsBonus number Combat Effects bonus from gear and spells ---- @field public CombatState string Returns one of the following: COMBAT, DEBUFFED, COOLDOWN, ACTIVE, RESTING, UNKNOWN ---- @field public Copper number Copper on your character ---- @field public CopperBank number Copper in bank +--- @field public Buyer fun(): boolean if you are an active buyer +--- @field public CanMount fun(): boolean for some indoor zones that where not flagged as nomount and added bazaar, nexus to zones where its ok to mount. +--- @field public CareerFavor fun(): number Career favor/tribute +--- @field public Cash fun(): number Total cash on your character, expressed in coppers (eg. if you are carrying 100pp, Cash will return 100000) +--- @field public CashBank fun(): number Total cash in your bank, expressed in coppers +--- @field public CHA fun(): number Character Charisma +--- @field public Chronobines fun(): number Chronobines on your character +--- @field public ClairvoyanceBonus fun(): number Clairvoyance Bonus +--- @field public Combat fun(): boolean In combat? +--- @field public CombatAbility fun(): number The number of Combat ability name in your list (not the same as anyone else's list!) +--- @field public CombatAbilityReady fun(): boolean Is this Combat Ability ready? +--- @field public CombatAbilityTimer fun(): number The time remaining (in seconds) before the Combat Ability name is usable +--- @field public CombatEffectsBonus fun(): number Combat Effects bonus from gear and spells +--- @field public CombatState fun(): string Returns one of the following: COMBAT, DEBUFFED, COOLDOWN, ACTIVE, RESTING, UNKNOWN +--- @field public Copper fun(): number Copper on your character +--- @field public CopperBank fun(): number Copper in bank --- @field public Corrupted spell Returns the name of the Corrupted debuff if you have one ---- @field public CountBuffs number Number of buffs you have, not including short duration buffs ---- @field public CountersCurse number Number of curse counters you have ---- @field public CountersDisease number Number of disease counters you have ---- @field public CountersPoison number Number of poison counters you have ---- @field public CountSongs number Number of songs you have ---- @field public Counters number Damage Absorption Counters Remaining ---- @field public CurrentEndurance number Current endurance ---- @field public CurrentFavor number Current favor/tribute ---- @field public CurrentHPs number Current hit points ---- @field public CurrentMana number Current mana ---- @field public CurrentWeight number Current weight +--- @field public CountBuffs fun(): number Number of buffs you have, not including short duration buffs +--- @field public CountersCurse fun(): number Number of curse counters you have +--- @field public CountersDisease fun(): number Number of disease counters you have +--- @field public CountersPoison fun(): number Number of poison counters you have +--- @field public CountSongs fun(): number Number of songs you have +--- @field public Counters fun(): number Damage Absorption Counters Remaining +--- @field public CurrentEndurance fun(): number Current endurance +--- @field public CurrentFavor fun(): number Current favor/tribute +--- @field public CurrentHPs fun(): number Current hit points +--- @field public CurrentMana fun(): number Current mana +--- @field public CurrentWeight fun(): number Current weight --- @field public Cursed spell Returns the name of the Curse debuff if you are effected by one ---- @field public DamageShieldBonus number Damage Shield bonus from gear and spells ---- @field public DamageShieldMitigationBonus number Damage Shield Mitigation bonus from gear and spells ---- @field public Dar number Damage absorption remaining (eg. from Rune-type spells) ---- @field public Diseased string Returns the name of any Disease spell ---- @field public DEX number Character Dexterity ---- @field public Dotted string Returns name of first DoT on character. ---- @field public DoTShieldBonus number DoT Shield bonus from gear and spells ---- @field public Doubloons number Doubloons on your character +--- @field public DamageShieldBonus fun(): number Damage Shield bonus from gear and spells +--- @field public DamageShieldMitigationBonus fun(): number Damage Shield Mitigation bonus from gear and spells +--- @field public Dar fun(): number Damage absorption remaining (eg. from Rune-type spells) +--- @field public Diseased fun(): string Returns the name of any Disease spell +--- @field public DEX fun(): number Character Dexterity +--- @field public Dotted fun(): string Returns name of first DoT on character. +--- @field public DoTShieldBonus fun(): number DoT Shield bonus from gear and spells +--- @field public Doubloons fun(): number Doubloons on your character --- @field public Downtime ticks Downtime (Ticks left til combat timer end) ---- @field public Drunk number Drunkenness level ---- @field public EbonCrystals number Number of Ebon Crystals on your character ---- @field public EnduranceBonus number Endurance bonus from gear and spells ---- @field public EnduranceRegen number Endurance regen from the last tick ---- @field public EnduranceRegenBonus number Endurance regen bonus ---- @field public Exp number Experience (out of 10,000) ---- @field public ExpansionFlags number Returns a numeric number representing which expansions your toon is flagged for ---- @field public Faycites number Faycites on your character +--- @field public Drunk fun(): number Drunkenness level +--- @field public EbonCrystals fun(): number Number of Ebon Crystals on your character +--- @field public EnduranceBonus fun(): number Endurance bonus from gear and spells +--- @field public EnduranceRegen fun(): number Endurance regen from the last tick +--- @field public EnduranceRegenBonus fun(): number Endurance regen bonus +--- @field public Exp fun(): number Experience (out of 10,000) +--- @field public ExpansionFlags fun(): number Returns a numeric number representing which expansions your toon is flagged for +--- @field public Faycites fun(): number Faycites on your character --- @field public Fellowship fellowship Info about Fellowship ---- @field public FreeBuffSlots number Number of open buff slots (not counting the short duration buff slots) ---- @field public FreeInventory number Number of free inventory spaces ---- @field public Gem number Returns the slot # with the spell name +--- @field public FreeBuffSlots fun(): number Number of open buff slots (not counting the short duration buff slots) +--- @field public FreeInventory fun(): number Number of free inventory spaces +--- @field public Gem fun(): number Returns the slot # with the spell name --- @field public GemTimer spell The timer for the spell with this name or in this gem # ---- @field public Gold number Gold on character ---- @field public GoldBank number Gold in bank +--- @field public Gold fun(): number Gold on character +--- @field public GoldBank fun(): number Gold in bank --- @field public GroupAssistTarget spawn Current group assist target ---- @field public Grouped boolean Grouped? ---- @field public GroupLeaderExp number Group leadership experience (out of 330) ---- @field public GroupLeaderPoints number Group leadership points ---- @field public GroupList string Returns a string of your group members (excluding you) +--- @field public Grouped fun(): boolean Grouped? +--- @field public GroupLeaderExp fun(): number Group leadership experience (out of 330) +--- @field public GroupLeaderPoints fun(): number Group leadership points +--- @field public GroupList fun(): string Returns a string of your group members (excluding you) --- @field public GroupMarkNPC spawn Current group marked NPC (1-3) ---- @field public GroupSize number Size of group ---- @field public GukEarned number Total LDoN points earned in Deepest Guk ---- @field public GuildID number Returns the ID number of your guild ---- @field public HaveExpansion boolean Returns TRUE/FALSE if you have that expansion # ---- @field public Haste number Total Combined Haste (worn and spell) as shown in Inventory Window stats ---- @field public HealAmountBonus number Total Heal Amount bonus from gear ---- @field public HeroicAGIBonus number Total Heroic Agility bonus from gear ---- @field public HeroicCHABonus number Total Heroic Charisma bonus from gear ---- @field public HeroicDEXBonus number Total Heroic Dexterity bonus from gear ---- @field public HeroicINTBonus number Total Heroic Intelligence bonus from gear ---- @field public HeroicSTABonus number Total Heroic Stamina bonus from gear ---- @field public HeroicSTRBonus number Total Heroic Strength bonus from gear ---- @field public HeroicWISBonus number Total Heroic Wisdom bonus from gear ---- @field public HPBonus number Hit point bonus from gear and spells ---- @field public HPRegen number Hit point regeneration from last tick ---- @field public HPRegenBonus number HP regen bonus from gear and spells ---- @field public Hunger number Hunger level ---- @field public ID number Spawn ID ---- @field public InInstance boolean Returns TRUE/FALSE if you are in an instance. ---- @field public INT number Character Intelligence +--- @field public GroupSize fun(): number Size of group +--- @field public GukEarned fun(): number Total LDoN points earned in Deepest Guk +--- @field public GuildID fun(): number Returns the ID number of your guild +--- @field public HaveExpansion fun(): boolean Returns TRUE/FALSE if you have that expansion # +--- @field public Haste fun(): number Total Combined Haste (worn and spell) as shown in Inventory Window stats +--- @field public HealAmountBonus fun(): number Total Heal Amount bonus from gear +--- @field public HeroicAGIBonus fun(): number Total Heroic Agility bonus from gear +--- @field public HeroicCHABonus fun(): number Total Heroic Charisma bonus from gear +--- @field public HeroicDEXBonus fun(): number Total Heroic Dexterity bonus from gear +--- @field public HeroicINTBonus fun(): number Total Heroic Intelligence bonus from gear +--- @field public HeroicSTABonus fun(): number Total Heroic Stamina bonus from gear +--- @field public HeroicSTRBonus fun(): number Total Heroic Strength bonus from gear +--- @field public HeroicWISBonus fun(): number Total Heroic Wisdom bonus from gear +--- @field public HPBonus fun(): number Hit point bonus from gear and spells +--- @field public HPRegen fun(): number Hit point regeneration from last tick +--- @field public HPRegenBonus fun(): number HP regen bonus from gear and spells +--- @field public Hunger fun(): number Hunger level +--- @field public ID fun(): number Spawn ID +--- @field public InInstance fun(): boolean Returns TRUE/FALSE if you are in an instance. +--- @field public INT fun(): number Character Intelligence --- @field public Inventory item Item in this slot # ---- @field public Invulnerable string Returns the invulnerable spell name on you, can be used with spell data type ex. ${Me.Invulnerable.Spell.ID} ---- @field public ItemReady boolean True/False on if the item is ready to cast. ---- @field public LADelegateMA number Level of Delegate MA of the current group leader (not your own ability level) ---- @field public LADelegateMarkNPC number Level of Delegate Mark NPC of the current group leader (not your own ability level) ---- @field public LAFindPathPC number Level of Find Path PC of the current group leader (not your own ability level) ---- @field public LAHealthEnhancement number Level of Health Enhancement of the current group leader (not your own ability level) ---- @field public LAHealthRegen number Level of Health Regen of the current group leader (not your own ability level) ---- @field public LAHoTT number Level of HoTT of the current group leader (not your own ability level) ---- @field public LAInspectBuffs number Level of Inspect Buffs of the current group leader (not your own ability level) ---- @field public LAManaEnhancement number Level of Mana Enhancement of the current group leader (not your own ability level) ---- @field public LAMarkNPC number Level of Mark NPC of the current group leader (not your own ability level) ---- @field public LANPCHealth number Level of NPC Health of the current group leader (not your own ability level) ---- @field public LAOffenseEnhancement number Level of Offense Enhancement of the current group leader (not your own ability level) ---- @field public LASpellAwareness number Level of Spell Awareness of the current group leader (not your own ability level) ---- @field public Language number The EQ language number of the specified language. See below for language/number table. ---- @field public LanguageSkill number Your skill in language ---- @field public LargestFreeInventory number Size of your largest free inventory space +--- @field public Invulnerable fun(): string Returns the invulnerable spell name on you, can be used with spell data type ex. ${Me.Invulnerable.Spell.ID} +--- @field public ItemReady fun(): boolean True/False on if the item is ready to cast. +--- @field public LADelegateMA fun(): number Level of Delegate MA of the current group leader (not your own ability level) +--- @field public LADelegateMarkNPC fun(): number Level of Delegate Mark NPC of the current group leader (not your own ability level) +--- @field public LAFindPathPC fun(): number Level of Find Path PC of the current group leader (not your own ability level) +--- @field public LAHealthEnhancement fun(): number Level of Health Enhancement of the current group leader (not your own ability level) +--- @field public LAHealthRegen fun(): number Level of Health Regen of the current group leader (not your own ability level) +--- @field public LAHoTT fun(): number Level of HoTT of the current group leader (not your own ability level) +--- @field public LAInspectBuffs fun(): number Level of Inspect Buffs of the current group leader (not your own ability level) +--- @field public LAManaEnhancement fun(): number Level of Mana Enhancement of the current group leader (not your own ability level) +--- @field public LAMarkNPC fun(): number Level of Mark NPC of the current group leader (not your own ability level) +--- @field public LANPCHealth fun(): number Level of NPC Health of the current group leader (not your own ability level) +--- @field public LAOffenseEnhancement fun(): number Level of Offense Enhancement of the current group leader (not your own ability level) +--- @field public LASpellAwareness fun(): number Level of Spell Awareness of the current group leader (not your own ability level) +--- @field public Language fun(): number The EQ language number of the specified language. See below for language/number table. +--- @field public LanguageSkill fun(): number Your skill in language +--- @field public LargestFreeInventory fun(): number Size of your largest free inventory space --- @field public LastZoned timestamp Returns a timestamp of last time you zoned ---- @field public LDoNPoints number Available LDoN points ---- @field public Level number Character Level ---- @field public ManaBonus number Mana bonus from gear and spells ---- @field public ManaRegen number Mana regeneration from last tick ---- @field public ManaRegenBonus number Mana regen bonus from gear and spells ---- @field public MaxBuffSlots number Max number of buffs you can have on you. /echo ${Me.MaxBuffSlots} ---- @field public MaxEndurance number Max endurance ---- @field public MaxHPs number Max hit points ---- @field public MaxMana number Max mana ---- @field public Mercenary string The state of your Mercenary, ACTIVE, SUSPENDED, or UNKNOWN (If it's dead). Returns NULL if you do not have a Mercenary. ---- @field public MercenaryStance string Current active mercenary stance as a string, default is NULL. ---- @field public MirEarned number Total LDoN points earned in Miragul's ---- @field public MMEarned number Total LDoN points earned in Mistmoore ---- @field public Moving boolean Moving? (including strafe) ---- @field public Name string First name ---- @field public NumGems number Returns the amount of spell gems your toon has ---- @field public Orux number Orux on your character ---- @field public PctAAExp number AA exp as a % ---- @field public PctAAVitality number Percentage of AA Vitality your toon has ---- @field public PctAggro number Your aggro percentage ---- @field public PctEndurance number Current endurance as a % ---- @field public PctExp number Experience as a % ---- @field public PctGroupLeaderExp number Group leadership exp as a % ---- @field public PctHPs number Current HP as a % ---- @field public PctMana number Current mana as a % ---- @field public PctRaidLeaderExp number Raid leadership experience as a % ---- @field public PctVitality number Percentage of Vitality the toon has +--- @field public LDoNPoints fun(): number Available LDoN points +--- @field public Level fun(): number Character Level +--- @field public ManaBonus fun(): number Mana bonus from gear and spells +--- @field public ManaRegen fun(): number Mana regeneration from last tick +--- @field public ManaRegenBonus fun(): number Mana regen bonus from gear and spells +--- @field public MaxBuffSlots fun(): number Max number of buffs you can have on you. /echo ${Me.MaxBuffSlots} +--- @field public MaxEndurance fun(): number Max endurance +--- @field public MaxHPs fun(): number Max hit points +--- @field public MaxMana fun(): number Max mana +--- @field public Mercenary fun(): string The state of your Mercenary, ACTIVE, SUSPENDED, or UNKNOWN (If it's dead). Returns NULL if you do not have a Mercenary. +--- @field public MercenaryStance fun(): string Current active mercenary stance as a string, default is NULL. +--- @field public MirEarned fun(): number Total LDoN points earned in Miragul's +--- @field public MMEarned fun(): number Total LDoN points earned in Mistmoore +--- @field public Moving fun(): boolean Moving? (including strafe) +--- @field public Name fun(): string First name +--- @field public NumGems fun(): number Returns the amount of spell gems your toon has +--- @field public Orux fun(): number Orux on your character +--- @field public PctAAExp fun(): number AA exp as a % +--- @field public PctAAVitality fun(): number Percentage of AA Vitality your toon has +--- @field public PctAggro fun(): number Your aggro percentage +--- @field public PctEndurance fun(): number Current endurance as a % +--- @field public PctExp fun(): number Experience as a % +--- @field public PctGroupLeaderExp fun(): number Group leadership exp as a % +--- @field public PctHPs fun(): number Current HP as a % +--- @field public PctMana fun(): number Current mana as a % +--- @field public PctRaidLeaderExp fun(): number Raid leadership experience as a % +--- @field public PctVitality fun(): number Percentage of Vitality the toon has --- @field public PetBuff spell The spell in this PetBuff slot # ---- @field public Phosphenes number Phosphenes on your character ---- @field public Phosphites number Phosphites on your character ---- @field public Platinum number Platinum on your character ---- @field public PlatinumBank number Platinum in bank ---- @field public PlatinumShared number Platinum in shared bank ---- @field public Poisoned string Returns the name of any Poison spell ---- @field public RadiantCrystals number Number of Radiant Crystals on your character +--- @field public Phosphenes fun(): number Phosphenes on your character +--- @field public Phosphites fun(): number Phosphites on your character +--- @field public Platinum fun(): number Platinum on your character +--- @field public PlatinumBank fun(): number Platinum in bank +--- @field public PlatinumShared fun(): number Platinum in shared bank +--- @field public Poisoned fun(): string Returns the name of any Poison spell +--- @field public RadiantCrystals fun(): number Number of Radiant Crystals on your character --- @field public RaidAssistTarget spawn Current raid assist target (1-3) ---- @field public RaidLeaderExp number Raid leadership exp (out of 330) ---- @field public RaidLeaderPoints number Raid leadership points +--- @field public RaidLeaderExp fun(): number Raid leadership exp (out of 330) +--- @field public RaidLeaderPoints fun(): number Raid leadership points --- @field public RaidMarkNPC spawn Current raid marked NPC (1-3) ---- @field public RangedReady boolean Ranged attack ready? ---- @field public RujEarned number Total LDoN points earned in Rujarkian ---- @field public Running boolean Do I have auto-run turned on? ---- @field public SecondaryPctAggro number Secondary Percentage aggro +--- @field public RangedReady fun(): boolean Ranged attack ready? +--- @field public RujEarned fun(): number Total LDoN points earned in Rujarkian +--- @field public Running fun(): boolean Do I have auto-run turned on? +--- @field public SecondaryPctAggro fun(): number Secondary Percentage aggro --- @field public SecondaryAggroPlayer spawn spawninfo for secondary aggro player ---- @field public ShieldingBonus number Shielding bonus from gear and spells ---- @field public Shrouded boolean Am I Shrouded? ---- @field public Silenced string Returns the name of the Silence type effect on you ---- @field public Silver number Silver on your character ---- @field public SilverBank number Silver in bank +--- @field public ShieldingBonus fun(): number Shielding bonus from gear and spells +--- @field public Shrouded fun(): boolean Am I Shrouded? +--- @field public Silenced fun(): string Returns the name of the Silence type effect on you +--- @field public Silver fun(): number Silver on your character +--- @field public SilverBank fun(): number Silver in bank --- @field public Sit fun() Causes toon to sit if not already ---- @field public Skill number Skill level of skill with this name or ID # ---- @field public SkillCap number Skill cap of skill with this name or ID # +--- @field public Skill fun(): number Skill level of skill with this name or ID # +--- @field public SkillCap fun(): number Skill cap of skill with this name or ID # --- @field public Song buff Finds song with this name --- @field public Spawn spawn The character's spawn ---- @field public SpellInCooldown boolean returns TRUE if you have a spell in cooldown and FALSE when not. ---- @field public SpellDamageBonus number Spell Damage bonus ---- @field public SpellRankCap number your characters spell rank cap. if it returns: 1 = Rk. I spells 2 = Rk. II spells 3 = Rk. III spells ---- @field public SpellReady boolean Gem with this spell name or in this gem # ready to cast? ---- @field public SpellShieldBonus number Spell Shield bonus from gear and spells ---- @field public STA number Character Stamina +--- @field public SpellInCooldown fun(): boolean returns TRUE if you have a spell in cooldown and FALSE when not. +--- @field public SpellDamageBonus fun(): number Spell Damage bonus +--- @field public SpellRankCap fun(): number your characters spell rank cap. if it returns: 1 = Rk. I spells 2 = Rk. II spells 3 = Rk. III spells +--- @field public SpellReady fun(): boolean Gem with this spell name or in this gem # ready to cast? +--- @field public SpellShieldBonus fun(): number Spell Shield bonus from gear and spells +--- @field public STA fun(): number Character Stamina --- @field public Stand fun() causes toon to stand if not already --- @field public StopCast fun() Causes toon to stop casting ---- @field public STR number Character Strength ---- @field public StrikeThroughBonus number Strikethrough bonus from gear and spells ---- @field public Stunned boolean Am I stunned? ---- @field public StunResistBonus number Stun Resist bonus from gear and spells ---- @field public Subscription string Subscription type GOLD, FREE, (Silver?) ---- @field public SubscriptionDays number Returns an intUsage: /echo I have ${Me.SubscriptionDays} left before my all access expires. ---- @field public Surname string Last name ---- @field public svChromatic number Your character's lowest resist ---- @field public svCold number Character Cold Resist ---- @field public svCorruption number Character Corruption Resist ---- @field public svDisease number Character Disease Resist ---- @field public svFire number Character Fire Resist ---- @field public svMagic number Character Magic Resist ---- @field public svPoison number Character Poison Resist ---- @field public svPrismatic number The average of your character's resists ---- @field public TakEarned number Total LDoN points earned in Takish +--- @field public STR fun(): number Character Strength +--- @field public StrikeThroughBonus fun(): number Strikethrough bonus from gear and spells +--- @field public Stunned fun(): boolean Am I stunned? +--- @field public StunResistBonus fun(): number Stun Resist bonus from gear and spells +--- @field public Subscription fun(): string Subscription type GOLD, FREE, (Silver?) +--- @field public SubscriptionDays fun(): number Returns an intUsage: /echo I have ${Me.SubscriptionDays} left before my all access expires. +--- @field public Surname fun(): string Last name +--- @field public svChromatic fun(): number Your character's lowest resist +--- @field public svCold fun(): number Character Cold Resist +--- @field public svCorruption fun(): number Character Corruption Resist +--- @field public svDisease fun(): number Character Disease Resist +--- @field public svFire fun(): number Character Fire Resist +--- @field public svMagic fun(): number Character Magic Resist +--- @field public svPoison fun(): number Character Poison Resist +--- @field public svPrismatic fun(): number The average of your character's resists +--- @field public TakEarned fun(): number Total LDoN points earned in Takish --- @field public TargetOfTarget target Target of Target (will only work when group or raid Target of Target is active; if not, it will return NULL) ---- @field public Thirst number Thirst level ---- @field public Trader boolean if you are an active Trader ---- @field public TributeActive boolean Tribute Active +--- @field public Thirst fun(): number Thirst level +--- @field public Trader fun(): boolean if you are an active Trader +--- @field public TributeActive fun(): boolean Tribute Active --- @field public TributeTimer ticks Tribute Timer ---- @field public UseAdvancedLooting boolean TRUE/FALSE if using advanced looting ---- @field public WIS number Character Wisdom ---- @field public XTarget xtarget Extended target data for the specified XTarget #. Note: Passing no index to this returns the number of current extended targets. ---- @field public Vitality number Total amount of Vitality your toon has \ No newline at end of file +--- @field public UseAdvancedLooting fun(): boolean TRUE/FALSE if using advanced looting +--- @field public WIS fun(): number Character Wisdom +--- @field public XTarget xtarget Extended target data for the specified XTarget #. Note: Passing no index to this returns the fun(): number of current extended targets. +--- @field public Vitality fun(): number Total amount of Vitality your toon has \ No newline at end of file diff --git a/datatype/_group.lua b/datatype/_group.lua index 2d4d815..e133810 100644 --- a/datatype/_group.lua +++ b/datatype/_group.lua @@ -1,24 +1,24 @@ --- @class group ---- @field public AnyoneMissing boolean TRUE if someone is missing in group, offline, in other zone or simply just dead ---- @field public CasterMercCount number count of how many Caster DPS mercenaries are in your group ---- @field public Cleric string Will now return the cleric as a spawntype if a cleric is in the group (not a mercenary but a REAL cleric) ---- @field public GroupSize number Number of members in your group, including yourself ---- @field public HealerMercCount number count of how many Healer mercenaries are in your group ---- @field public Injured number Will return the numbers of people in the group that has a hp percent lower than 90 ---- @field public Leader groupmember Data on the leader of the group ---- @field public MainAssist groupmember Data on the main assist of the group ---- @field public MainTank groupmember Data on the main tank of the group ---- @field public MarkNpc groupmember Data on the group member who can mark NPCs, if one is assigned ---- @field public MasterLooter groupmember Data on the Master Looter of the group, if one is assigned ---- @field public MeleeMercCount number count of how many Melee DPS mercenaries are in your group ---- @field public Member groupmember Accesses #th member of your group; 0 is you, 1 is the first person in the group list, etc. ---- @field public Member.Index number Which number in the group the PC with name is +--- @field public AnyoneMissing fun(): boolean TRUE if someone is missing in group, offline, in other zone or simply just dead +--- @field public CasterMercCount fun(): number count of how many Caster DPS mercenaries are in your group +--- @field public Cleric fun(): string Will now return the cleric as a spawntype if a cleric is in the group (not a mercenary but a REAL cleric) +--- @field public GroupSize fun(): number Number of members in your group, including yourself +--- @field public HealerMercCount fun(): number count of how many Healer mercenaries are in your group +--- @field public Injured fun(): number Will return the numbers of people in the group that has a hp percent lower than 90 +--- @field public Leader fun(): groupmember Data on the leader of the group +--- @field public MainAssist fun(): groupmember Data on the main assist of the group +--- @field public MainTank fun(): groupmember Data on the main tank of the group +--- @field public MarkNpc fun(): groupmember Data on the group member who can mark NPCs, if one is assigned +--- @field public MasterLooter fun(): groupmember Data on the Master Looter of the group, if one is assigned +--- @field public MeleeMercCount fun(): number count of how many Melee DPS mercenaries are in your group +--- @field public Member fun(): groupmember Accesses #th member of your group; 0 is you, 1 is the first person in the group list, etc. +--- @field public Member.Index fun(): number Which number in the group the PC with name is --- @field public Member.Pet spawn Returns the group members' pet name ---- @field public Members number Total number of group members, excluding yourself ---- @field public MercenaryCount number Count of how many Mercenaries are in the group ---- @field public MouseOver string Returns the name of the group member your mouse is hovering over ---- @field public Offline boolean will return a TRUE if offline, and FALSE if online ---- @field public OtherZone boolean will return a Bool TRUE if online but in another zone and FALSE if online and in same zone as you. +--- @field public Members fun(): number Total number of group members, excluding yourself +--- @field public MercenaryCount fun(): number Count of how many Mercenaries are in the group +--- @field public MouseOver fun(): string Returns the name of the group member your mouse is hovering over +--- @field public Offline fun(): boolean will return a TRUE if offline, and FALSE if online +--- @field public OtherZone fun(): boolean will return a Bool TRUE if online but in another zone and FALSE if online and in same zone as you. --- @field public Puller groupmember Data on the puller of the group ---- @field public TankMercCount number count of how many Tank mercenaries are in your group ---- @field public ToString string Same as Members \ No newline at end of file +--- @field public TankMercCount fun(): number count of how many Tank mercenaries are in your group +--- @field public ToString fun(): string Same as Members \ No newline at end of file diff --git a/datatype/_groupmember.lua b/datatype/_groupmember.lua index 5e15029..08232a0 100644 --- a/datatype/_groupmember.lua +++ b/datatype/_groupmember.lua @@ -1,14 +1,14 @@ --- @class groupmember : spawn ---- @field public Index number Which number in the group the member is ---- @field public Leader boolean TRUE if the member is the group's leader, FALSE otherwise ---- @field public Level number The member's level ---- @field public MainAssist boolean TRUE if the member is designated as the group's Main Assist, FALSE otherwise ---- @field public MainTank boolean TRUE if the member is designated as the group's Main Tank, FALSE otherwise ---- @field public Mercenary boolean TRUE if the member is a mercenary, FALSE otherwise ---- @field public Name string The name of the group member. This works even if they are not in the same zone as you. ---- @field public Offline boolean TRUE if the member is offline and FALSE if online ---- @field public OtherZone boolean TRUE if the member is online but in another zone and FALSE if online and in same zone as you. ---- @field public Present boolean TRUE if the member is online and in same zone and FALSE if online and not in same zone as you. ---- @field public Puller boolean TRUE if the member is designated as the group's Puller, FALSE otherwise +--- @field public Index fun(): number Which number in the group the member is +--- @field public Leader fun(): boolean TRUE if the member is the group's leader, FALSE otherwise +--- @field public Level fun(): number The member's level +--- @field public MainAssist fun(): boolean TRUE if the member is designated as the group's Main Assist, FALSE otherwise +--- @field public MainTank fun(): boolean TRUE if the member is designated as the group's Main Tank, FALSE otherwise +--- @field public Mercenary fun(): boolean TRUE if the member is a mercenary, FALSE otherwise +--- @field public Name fun(): string The name of the group member. This works even if they are not in the same zone as you. +--- @field public Offline fun(): boolean TRUE if the member is offline and FALSE if online +--- @field public OtherZone fun(): boolean TRUE if the member is online but in another zone and FALSE if online and in same zone as you. +--- @field public Present fun(): boolean TRUE if the member is online and in same zone and FALSE if online and not in same zone as you. +--- @field public Puller fun(): boolean TRUE if the member is designated as the group's Puller, FALSE otherwise --- @field public Spawn spawn Accesses the group member's spawn directly. This is only really needed to access Spawn.Name, instead of GroupMember.Name, as spawn is inherited automatically. ---- @field public ToString string Same as Name \ No newline at end of file +--- @field public ToString fun(): string Same as Name \ No newline at end of file diff --git a/datatype/_heading.lua b/datatype/_heading.lua index 14e77ea..eabb860 100644 --- a/datatype/_heading.lua +++ b/datatype/_heading.lua @@ -1,6 +1,6 @@ --- @class heading ---- @field public Clock number The nearest clock direction, e.g. 1-12 ---- @field public Degrees number Heading in degrees ---- @field public DegreesCCW number Heading in degrees counter-clockwise. This is the way the rest of MQ and EQ uses it. ---- @field public Name string The long compass direction, e.g. "south by southeast" ---- @field public ShortName string The short compass direction, e.g. "SSE" \ No newline at end of file +--- @field public Clock fun(): number The nearest clock direction, e.g. 1-12 +--- @field public Degrees fun(): number Heading in degrees +--- @field public DegreesCCW fun(): number Heading in degrees counter-clockwise. This is the way the rest of MQ and EQ uses it. +--- @field public Name fun(): string The long compass direction, e.g. "south by southeast" +--- @field public ShortName fun(): string The short compass direction, e.g. "SSE" \ No newline at end of file diff --git a/datatype/_item.lua b/datatype/_item.lua index 8fffa9a..d86cc55 100644 --- a/datatype/_item.lua +++ b/datatype/_item.lua @@ -1,114 +1,114 @@ --- @class item ---- @field public AC number AC value on item ---- @field public AGI number AGI value on item ---- @field public Accuracy number Accuracy ---- @field public Attack number Attack value on item ---- @field public Attuneable boolean Attuneable? ---- @field public AugRestrictions number Augment Restrictions ---- @field public Augs number Number of augs on this item ---- @field public AugSlot1 number Aug slot 1 ---- @field public AugSlot2 number Aug slot 2 ---- @field public AugSlot3 number Aug slot 3 ---- @field public AugSlot4 number Aug slot 4 ---- @field public AugSlot5 number Aug slot 5 ---- @field public AugType number Augment Type ---- @field public Avoidance number Avoidance ---- @field public BuyPrice number The cost to buy this item from active merchant +--- @field public AC fun(): number AC value on item +--- @field public AGI fun(): number AGI value on item +--- @field public Accuracy fun(): number Accuracy +--- @field public Attack fun(): number Attack value on item +--- @field public Attuneable fun(): boolean Attuneable? +--- @field public AugRestrictions fun(): number Augment Restrictions +--- @field public Augs fun(): number Number of augs on this item +--- @field public AugSlot1 fun(): number Aug slot 1 +--- @field public AugSlot2 fun(): number Aug slot 2 +--- @field public AugSlot3 fun(): number Aug slot 3 +--- @field public AugSlot4 fun(): number Aug slot 4 +--- @field public AugSlot5 fun(): number Aug slot 5 +--- @field public AugType fun(): number Augment Type +--- @field public Avoidance fun(): number Avoidance +--- @field public BuyPrice fun(): number The cost to buy this item from active merchant --- @field public CastTime float Spell effect's cast time (in seconds) ---- @field public CHA number CHA value on item ---- @field public Charges number Charges ---- @field public Clairvoyance number Clairvoyance ---- @field public Class string Returns the #th long class name of the listed classes on an item. Items suitable for ALL classes will effectively have all 17 classes listed. ---- @field public Classes number The number of classes that can use the item. Items suitable for ALL classes will return 16. +--- @field public CHA fun(): number CHA value on item +--- @field public Charges fun(): number Charges +--- @field public Clairvoyance fun(): number Clairvoyance +--- @field public Class fun(): string Returns the #th long class name of the listed classes on an item. Items suitable for ALL classes will effectively have all 17 classes listed. +--- @field public Classes fun(): number The number of classes that can use the item. Items suitable for ALL classes will return 16. --- @field public Clicky itemspell Activatable spell effect, if any. ---- @field public CombatEffects number CombatEffects ---- @field public Container number Number of slots, if this is a container ---- @field public DamageShieldMitigation number Damage Shield Mitigation ---- @field public DamShield number Damage Shield value on item ---- @field public Deity string Returns the #th deity of the listed deities on an item. Items with no deity restrictions will return NULL for all values of #. ---- @field public Deities number The number of deities that can use the item. Items with no deity restrictions will return 0. ---- @field public DEX number DEX value on item ---- @field public DMGBonusType string "None", "Magic", "Fire", "Cold", "Poison", "Disease" ---- @field public DoTShielding number DoT Shielding ---- @field public EffectType string Spell effect type (see below for spell effect types) ---- @field public Endurance number Endurance ---- @field public EnduranceRegen number Endurance regen +--- @field public CombatEffects fun(): number CombatEffects +--- @field public Container fun(): number Number of slots, if this is a container +--- @field public DamageShieldMitigation fun(): number Damage Shield Mitigation +--- @field public DamShield fun(): number Damage Shield value on item +--- @field public Deity fun(): string Returns the #th deity of the listed deities on an item. Items with no deity restrictions will return NULL for all values of #. +--- @field public Deities fun(): number The number of deities that can use the item. Items with no deity restrictions will return 0. +--- @field public DEX fun(): number DEX value on item +--- @field public DMGBonusType fun(): string "None", "Magic", "Fire", "Cold", "Poison", "Disease" +--- @field public DoTShielding fun(): number DoT Shielding +--- @field public EffectType fun(): string Spell effect type (see below for spell effect types) +--- @field public Endurance fun(): number Endurance +--- @field public EnduranceRegen fun(): number Endurance regen --- @field public Evolving evolving Does this item have Evolving experience on? ---- @field public FreeStack number The number of items needed to fill all the stacks of the item you have (with a stacksize of 20).If you have 3 stacks (1, 10, 20 in those stacks), you have room for 60 total and you have 31 on you, so FreeStack would return 29. ---- @field public Haste number Haste value on item ---- @field public HealAmount number HealAmount (regen?) ---- @field public HeroicAGI number Heroic AGI value on item ---- @field public HeroicCHA number Heroic CHA value on item ---- @field public HeroicDEX number Heroic DEX value on item ---- @field public HeroicINT number Heroic INT value on item ---- @field public HeroicSTA number Heroic STA value on item ---- @field public HeroicSTR number Heroic STR value on item ---- @field public HeroicSvCold number Heroic SvCold value on item ---- @field public HeroicSvCorruption number Heroic SvCorruption value on item ---- @field public HeroicSvDisease number Heroic SvDisease value on item ---- @field public HeroicSvFire number Heroic SvFire value on item ---- @field public HeroicSvMagic number Heroic SvMagic value on item ---- @field public HeroicSvPoison number Heroic SvPoison value on item ---- @field public HeroicWIS number Heroic WIS value on item ---- @field public HP number HP value on item ---- @field public HPRegen number HPRegen value on item ---- @field public Icon number Item Icon ---- @field public ID number Item ID +--- @field public FreeStack fun(): number The number of items needed to fill all the stacks of the item you have (with a stacksize of 20).If you have 3 stacks (1, 10, 20 in those stacks), you have room for 60 total and you have 31 on you, so FreeStack would return 29. +--- @field public Haste fun(): number Haste value on item +--- @field public HealAmount fun(): number HealAmount (regen?) +--- @field public HeroicAGI fun(): number Heroic AGI value on item +--- @field public HeroicCHA fun(): number Heroic CHA value on item +--- @field public HeroicDEX fun(): number Heroic DEX value on item +--- @field public HeroicINT fun(): number Heroic INT value on item +--- @field public HeroicSTA fun(): number Heroic STA value on item +--- @field public HeroicSTR fun(): number Heroic STR value on item +--- @field public HeroicSvCold fun(): number Heroic SvCold value on item +--- @field public HeroicSvCorruption fun(): number Heroic SvCorruption value on item +--- @field public HeroicSvDisease fun(): number Heroic SvDisease value on item +--- @field public HeroicSvFire fun(): number Heroic SvFire value on item +--- @field public HeroicSvMagic fun(): number Heroic SvMagic value on item +--- @field public HeroicSvPoison fun(): number Heroic SvPoison value on item +--- @field public HeroicWIS fun(): number Heroic WIS value on item +--- @field public HP fun(): number HP value on item +--- @field public HPRegen fun(): number HPRegen value on item +--- @field public Icon fun(): number Item Icon +--- @field public ID fun(): number Item ID --- @field public InstrumentMod float Instrument Modifier Value ---- @field public INT number INT value on item ---- @field public InvSlot number Inventory Slot Number (Historic and now deprecated, use ItemSlot and ItemSlot2) +--- @field public INT fun(): number INT value on item +--- @field public InvSlot fun(): number Inventory Slot Number (Historic and now deprecated, use ItemSlot and ItemSlot2) --- @field public Item item Item in #th slot, if this is a container or has augs --- @field public ItemDelay float Returns the delay of the weapon --- @field public ItemLink item just prints the actual hexlink for an item (not clickable) unless [CLICKABLE] is included ---- @field public Items number Number of items, if this is a container. ---- @field public ItemSlot number Item Slot number see Slot Names ---- @field public ItemSlot2 number Item Slot subnumber see Slot Names ---- @field public LDoNTheme string "All", "Deepest Guk", "Miragul's", "Mistmoore", "Rujarkian", "Takish", "Unknown" ---- @field public Lore boolean Lore? ---- @field public Magic boolean Magic? ---- @field public Mana number Mana value on item ---- @field public ManaRegen number ManaRegen value on item ---- @field public MaxPower number Max power on an power source ---- @field public MerchQuantity number Quantity of item active merchant has ---- @field public Name string Name ---- @field public NoDrop boolean No Trade? ---- @field public NoRent boolean Temporary? ---- @field public Power number Power left on power source ---- @field public Purity number Purity of item ---- @field public Race string Returns the #th long race name of the listed races on an item. Items suitable for ALL races will effectively have all 15 races listed. ---- @field public Races number The number of races that can use the item. Items suitable for ALL races will return 15. ---- @field public RequiredLevel number Returns the Required Level of an item. Items with no required level will return 0. ---- @field public SellPrice number Price to sell this item at this merchant ---- @field public Shielding number Shielding ---- @field public Size number Item size:1 SMALL2 MEDIUM3 LARGE4 GIANT ---- @field public SizeCapacity number If item is a container, size of items it can hold:1 SMALL2 MEDIUM3 LARGE4 GIANT +--- @field public Items fun(): number Number of items, if this is a container. +--- @field public ItemSlot fun(): number Item Slot number see Slot Names +--- @field public ItemSlot2 fun(): number Item Slot sub number see Slot Names +--- @field public LDoNTheme fun(): string "All", "Deepest Guk", "Miragul's", "Mistmoore", "Rujarkian", "Takish", "Unknown" +--- @field public Lore fun(): boolean Lore? +--- @field public Magic fun(): boolean Magic? +--- @field public Mana fun(): number Mana value on item +--- @field public ManaRegen fun(): number ManaRegen value on item +--- @field public MaxPower fun(): number Max power on an power source +--- @field public MerchQuantity fun(): number Quantity of item active merchant has +--- @field public Name fun(): string Name +--- @field public NoDrop fun(): boolean No Trade? +--- @field public NoRent fun(): boolean Temporary? +--- @field public Power fun(): number Power left on power source +--- @field public Purity fun(): number Purity of item +--- @field public Race fun(): string Returns the #th long race name of the listed races on an item. Items suitable for ALL races will effectively have all 15 races listed. +--- @field public Races fun(): number The number of races that can use the item. Items suitable for ALL races will return 15. +--- @field public RequiredLevel fun(): number Returns the Required Level of an item. Items with no required level will return 0. +--- @field public SellPrice fun(): number Price to sell this item at this merchant +--- @field public Shielding fun(): number Shielding +--- @field public Size fun(): number Item size:1 SMALL2 MEDIUM3 LARGE4 GIANT +--- @field public SizeCapacity fun(): number If item is a container, size of items it can hold:1 SMALL2 MEDIUM3 LARGE4 GIANT --- @field public Spell spell Spell effect ---- @field public SpellDamage number Spell damage ---- @field public SpellShield number SpellShield ---- @field public STA number STA value on item ---- @field public Stack number Number of items in the stack ---- @field public Stacks number Number of stacks of the item in your inventory ---- @field public Stackable boolean Stackable? ---- @field public StackCount number The total number of the stackable item in your inventory ---- @field public StackSize number Maximum number if items that can be in the stack ---- @field public STR number STR value on item ---- @field public StrikeThrough number StrikeThrough ---- @field public StunResist number Stun resist ---- @field public svCold number svCold value on item ---- @field public svCorruption number svCorruption value on item ---- @field public svDisease number svDisease value on item ---- @field public svFire number svFire value on item ---- @field public svMagic number svMagic value on item ---- @field public svPoison number svPoison value on item +--- @field public SpellDamage fun(): number Spell damage +--- @field public SpellShield fun(): number SpellShield +--- @field public STA fun(): number STA value on item +--- @field public Stack fun(): number Number of items in the stack +--- @field public Stacks fun(): number Number of stacks of the item in your inventory +--- @field public Stackable fun(): boolean Stackable? +--- @field public StackCount fun(): number The total number of the stackable item in your inventory +--- @field public StackSize fun(): number Maximum number if items that can be in the stack +--- @field public STR fun(): number STR value on item +--- @field public StrikeThrough fun(): number StrikeThrough +--- @field public StunResist fun(): number Stun resist +--- @field public svCold fun(): number svCold value on item +--- @field public svCorruption fun(): number svCorruption value on item +--- @field public svDisease fun(): number svDisease value on item +--- @field public svFire fun(): number svFire value on item +--- @field public svMagic fun(): number svMagic value on item +--- @field public svPoison fun(): number svPoison value on item --- @field public Timer ticks Returns the number of ticks remaining on an item recast timer ---- @field public TimerReady number Returns the number of seconds remaining on an item recast timer ---- @field public Tradeskills boolean Tradeskills? ---- @field public Type string Type ---- @field public Tribute number Tribute value of the item ---- @field public Value number Item value in coppers ---- @field public Weight number Item weight ---- @field public WIS number WIS value on item +--- @field public TimerReady fun(): number Returns the number of seconds remaining on an item recast timer +--- @field public Tradeskills fun(): boolean Tradeskills? +--- @field public Type fun(): string Type +--- @field public Tribute fun(): number Tribute value of the item +--- @field public Value fun(): number Item value in coppers +--- @field public Weight fun(): number Item weight +--- @field public WIS fun(): number WIS value on item --- @field public WornSlot invslot The #th invslot this item can be worn in (fingers/ears count as 2 slots) -----@field public WornSlot boolean Can item be worn in invslot with this name? (worn slots only) ---- @field public WornSlots number The number of invslots this item can be worn in (fingers/ears count as 2 slots) ---- @field public ToString string Same as Name \ No newline at end of file +----@field public WornSlot fun(): boolean Can item be worn in invslot with this name? (worn slots only) +--- @field public WornSlots fun(): number The number of invslots this item can be worn in (fingers/ears count as 2 slots) +--- @field public ToString fun(): string Same as Name \ No newline at end of file diff --git a/datatype/_itemspell .lua b/datatype/_itemspell .lua index f1115ae..aac8367 100644 --- a/datatype/_itemspell .lua +++ b/datatype/_itemspell .lua @@ -1,13 +1,13 @@ --- @class itemspell --- @field public CastTime timestamp Cast time (unadjusted) ---- @field public EffectiveCasterLevel int|fun():integer Effective level that is used to cast the spell. ---- @field public EffectType int|fun():integer The type of item spell effect. ---- @field public MaxCharges int|fun():integer The maximum number of charges supported by this spell. ---- @field public OverrideDescription string|fun():string Overrides the normal spell description string, if set. ---- @field public OverrideName string|fun():string Overrides the normal spell name string, if set. ---- @field public ProcRate int|fun():integer Combat effect proc rate. ---- @field public RecastType int|fun():integer Recast type of the spell. ---- @field public RequiredLevel int|fun():integer Level required for the spell to be usable. +--- @field public EffectiveCasterLevel fun(): integer Effective level that is used to cast the spell. +--- @field public EffectType fun(): integer The type of item spell effect. +--- @field public MaxCharges fun(): integer The maximum number of charges supported by this spell. +--- @field public OverrideDescription fun(): string Overrides the normal spell description string, if set. +--- @field public OverrideName fun(): string Overrides the normal spell name string, if set. +--- @field public ProcRate fun(): integer Combat effect proc rate. +--- @field public RecastType fun(): integer Recast type of the spell. +--- @field public RequiredLevel fun(): integer Level required for the spell to be usable. --- @field public Spell spell The spell. ---- @field public SpellID int|fun():integer ID of the Spell. ---- @field public TimerID int|fun():integer Timer ID of the spell. \ No newline at end of file +--- @field public SpellID fun(): integer ID of the Spell. +--- @field public TimerID fun(): integer Timer ID of the spell. \ No newline at end of file diff --git a/datatype/_lua.lua b/datatype/_lua.lua index cefc573..afea7e7 100644 --- a/datatype/_lua.lua +++ b/datatype/_lua.lua @@ -1,18 +1,18 @@ --- @class LuaInfo ---- @field public PID int The PID of the running or most recently executed version of this script ---- @field public Name string The name of the script ---- @field public Path string The full path of the script ---- @field public Arguments string A comma delimited list of arguments passed to the script ---- @field public StartTime string The time the most recent execution of the script was started ---- @field public EndTime string The time the most recent execution of the script ended or NULL if the script has not ended ---- @field public ReturnCount int The number of returns from the script, will be 0 if the script has not ended ---- @field public Return fun(index: int): string string If not indexed, a comma-delimited list of return values. Accepts an integer index to get a single return value if there is more than one ---- @field public Status string The execution status of the script +--- @field public PID fun(): integer The PID of the running or most recently executed version of this script +--- @field public Name fun(): string The name of the script +--- @field public Path fun(): string The full path of the script +--- @field public Arguments fun(): string A comma delimited list of arguments passed to the script +--- @field public StartTime fun(): string The time the most recent execution of the script was started +--- @field public EndTime fun(): string The time the most recent execution of the script ended or NULL if the script has not ended +--- @field public ReturnCount fun(): integer The number of returns from the script, will be 0 if the script has not ended +--- @field public Return fun(index: integer): string string If not indexed, a comma-delimited list of return values. Accepts an integereger index to get a single return value if there is more than one +--- @field public Status fun(): string The execution status of the script --- --- @class Lua ---- @field public PIDs string A comma-delimited list of integer PIDs that have info to access ---- @field public Dir string The base lua scripts directory ---- @field public Turbo int The turbo value ---- @field public RequirePaths string The semicolon-delimited value for lua require search paths ---- @field public CRequirePaths string The semicolon-delimited value for dll require search paths ---- @field public Script fun(pid: int): LuaInfo The accessor to get info on individual scripts. Accepts a PID as an index, or will default to the last executed script that has finished running \ No newline at end of file +--- @field public PIDs fun(): string A comma-delimited list of integereger PIDs that have info to access +--- @field public Dir fun(): string The base lua scripts directory +--- @field public Turbo fun(): integer The turbo value +--- @field public RequirePaths fun(): string The semicolon-delimited value for lua require search paths +--- @field public CRequirePaths fun(): string The semicolon-delimited value for dll require search paths +--- @field public Script fun(pid: integer): LuaInfo The accessor to get info on individual scripts. Accepts a PID as an index, or will default to the last executed script that has finished running \ No newline at end of file diff --git a/datatype/_macro.lua b/datatype/_macro.lua index 2f4c71d..c8c6926 100644 --- a/datatype/_macro.lua +++ b/datatype/_macro.lua @@ -1,14 +1,14 @@ --- @class Macro ---- @field public CurCommand string list the current line number, macro name and code of the macro being processed ---- @field public CurLine number The current line number of the macro being processed ---- @field public CurSub string The current sub routine ---- @field public isOuterVariable boolean true if the provided parameter is a defined outer variable ---- @field public isTLO boolean true if the provided parameter an existing TLO ---- @field public MemUse number How much memory the macro is using ---- @field public Name string The name of the macro currently running ---- @field public Params number The number of parameters that were passed to the current subroutine ---- @field public Paused boolean NULL if no macro running, FALSE if mqpause is off, TRUE if mqpause is on ---- @field public Return string The value that was returned by the last completed subroutine ---- @field public RunTime number How long the macro has been running (in seconds) ---- @field public StackSize number StackSize? +--- @field public CurCommand fun(): string list the current line number, macro name and code of the macro being processed +--- @field public CurLine fun(): number The current line number of the macro being processed +--- @field public CurSub fun(): string The current sub routine +--- @field public isOuterVariable fun(): boolean true if the provided parameter is a defined outer variable +--- @field public isTLO fun(): boolean true if the provided parameter an existing TLO +--- @field public MemUse fun(): number How much memory the macro is using +--- @field public Name fun(): string The name of the macro currently running +--- @field public Params fun(): number The number of parameters that were passed to the current subroutine +--- @field public Paused fun(): boolean NULL if no macro running, FALSE if mqpause is off, TRUE if mqpause is on +--- @field public Return fun(): string The value that was returned by the last completed subroutine +--- @field public RunTime fun(): number How long the macro has been running (in seconds) +--- @field public StackSize fun(): number StackSize? --- @field public Undeclared fun() will list all undeclared variables \ No newline at end of file diff --git a/datatype/_macroquest.lua b/datatype/_macroquest.lua index e6fb7a2..48e02c2 100644 --- a/datatype/_macroquest.lua +++ b/datatype/_macroquest.lua @@ -1,25 +1,25 @@ --- @class macroquest ---- @field public BuildDate string Date that MQ2Main.dll was built ---- @field public ChatChannel boolean Returns TRUE if channel name is joined ---- @field public ChatChannels number Returns the number of channels currently joined ---- @field public Error string Last normal error message ---- @field public GameState string Returns "INGAME, CHARSELECT, PRECHARSELECT, UNKNOWN" ---- @field public LastCommand string Last command entered ---- @field public LastTell string Name of last person to send you a tell ---- @field public LClickedObject boolean Returns TRUE if an object has been left clicked ---- @field public LoginName string Your station name ---- @field public MouseX number Mouse's X location ---- @field public MouseY number Mouse's Y location ---- @field public MQ2DataError string Last MQ2Data parsing error message ---- @field public Path string Directory that Macroquest.exe launched from ---- @field public Ping number Your current ping ---- @field public Running number Running time of current MQ2 session, in milliseconds ---- @field public Server string Full name of your server ---- @field public SyntaxError string Last syntax error message ---- @field public ViewportX number EverQuest viewport upper left (X) position ---- @field public ViewportXCenter number EverQuest viewport center (X) position ---- @field public ViewportXMax number EverQuest viewport lower right (X) position ---- @field public ViewportY number EverQuest viewport upper left (Y) position ---- @field public ViewportYCenter number EverQuest viewport center (Y) position ---- @field public ViewportYMax number EverQuest viewport lower right (Y) position ---- @field public ToString string None \ No newline at end of file +--- @field public BuildDate fun(): string Date that MQ2Main.dll was built +--- @field public ChatChannel fun(): boolean Returns TRUE if channel name is joined +--- @field public ChatChannels fun(): number Returns the fun(): number of channels currently joined +--- @field public Error fun(): string Last normal error message +--- @field public GameState fun(): string Returns "INGAME, CHARSELECT, PRECHARSELECT, UNKNOWN" +--- @field public LastCommand fun(): string Last command entered +--- @field public LastTell fun(): string Name of last person to send you a tell +--- @field public LClickedObject fun(): boolean Returns TRUE if an object has been left clicked +--- @field public LoginName fun(): string Your station name +--- @field public MouseX fun(): number Mouse's X location +--- @field public MouseY fun(): number Mouse's Y location +--- @field public MQ2DataError fun(): string Last MQ2Data parsing error message +--- @field public Path fun(): string Directory that Macroquest.exe launched from +--- @field public Ping fun(): number Your current ping +--- @field public Running fun(): number Running time of current MQ2 session, in milliseconds +--- @field public Server fun(): string Full name of your server +--- @field public SyntaxError fun(): string Last syntax error message +--- @field public ViewportX fun(): number EverQuest viewport upper left (X) position +--- @field public ViewportXCenter fun(): number EverQuest viewport center (X) position +--- @field public ViewportXMax fun(): number EverQuest viewport lower right (X) position +--- @field public ViewportY fun(): number EverQuest viewport upper left (Y) position +--- @field public ViewportYCenter fun(): number EverQuest viewport center (Y) position +--- @field public ViewportYMax fun(): number EverQuest viewport lower right (Y) position +--- @field public ToString fun(): string None \ No newline at end of file diff --git a/datatype/_merchant.lua b/datatype/_merchant.lua index aa11538..ec2c16e 100644 --- a/datatype/_merchant.lua +++ b/datatype/_merchant.lua @@ -1,13 +1,13 @@ --- @class merchant ---- @field public Full boolean Returns TRUE if the merchant's inventory is full ---- @field public Items number Number of items on the merchant ---- @field public Item item Item number # on the merchant's list ---- @field public Markup float The number used to calculate the buy and sell value for an item (this is what is changed by charisma and ffun()). This value is capped at 1.05Markup*Item Value = Amount you buy item forItem Value*(1/Markup) = Amount you sell item for ---- @field public Open boolean Returns TRUE if merchant is open +--- @field public Full fun(): boolean Returns TRUE if the merchant's inventory is full +--- @field public Items fun(): number Number of items on the merchant +--- @field public Item item Item fun(): number # on the merchant's list +--- @field public Markup float The fun(): number used to calculate the buy and sell value for an item (this is what is changed by charisma and ffun()). This value is capped at 1.05Markup*Item Value = Amount you buy item forItem Value*(1/Markup) = Amount you sell item for +--- @field public Open fun(): boolean Returns TRUE if merchant is open --- @field public SelectedItem item The currently selected item in the merchant window, and item type ---- @field public ItemsReceived boolean True if the merchants itemlist has been filled in. +--- @field public ItemsReceived fun(): boolean True if the merchants itemlist has been filled in. --- @field public OpenWindow fun() Will open the merchant closest to you, or if you have a merchant target --- @field public SelectItem fun() Select item specified or partial match that fits. Use SelectItem[=xxx] for EXACT match(its not case sensitive) --- @field public Buy fun() Buys # of whatever is selected with Merchant.SelectItem[xxx] --- @field public Sell fun() Sell # of whatever is selected with /seletitem. See examples ---- @field public ToString boolean Same as Open \ No newline at end of file +--- @field public ToString fun(): boolean Same as Open \ No newline at end of file diff --git a/datatype/_spawn.lua b/datatype/_spawn.lua index 309f4bc..e65b212 100644 --- a/datatype/_spawn.lua +++ b/datatype/_spawn.lua @@ -1,151 +1,151 @@ --- @class spawn ---- @field public AARank number AA rank number ---- @field public AATitle string AA Title name ---- @field public ActorDef string Actor Defintion ---- @field public Address number Unknown? ---- @field public AFK boolean AFK? ---- @field public Aggressive boolean returns TRUE or FALSE if a mob is aggressive or not ---- @field public Animation number Current animation ID. See Animations for a list of animations. ---- @field public Anonymous boolean Anonymous ---- @field public Assist boolean Current Raid or Group assist target? ---- @field public AssistName string Name of current Raid or Group assist target ---- @field public bAlwaysShowAura boolean Show Auras? ---- @field public bBetaBuffed boolean Am I Beta Buffed? ---- @field public Binding boolean Binding wounds? ---- @field public Blind number Blind? Not sure why this is a number? +--- @field public AARank fun(): number AA rank number +--- @field public AATitle fun(): string AA Title name +--- @field public ActorDef fun(): string Actor Defintion +--- @field public Address fun(): number Unknown? +--- @field public AFK fun(): boolean AFK? +--- @field public Aggressive fun(): boolean returns TRUE or FALSE if a mob is aggressive or not +--- @field public Animation fun(): number Current animation ID. See Animations for a list of animations. +--- @field public Anonymous fun(): boolean Anonymous +--- @field public Assist fun(): boolean Current Raid or Group assist target? +--- @field public AssistName fun(): string Name of current Raid or Group assist target +--- @field public bAlwaysShowAura fun(): boolean Show Auras? +--- @field public bBetaBuffed fun(): boolean Am I Beta Buffed? +--- @field public Binding fun(): boolean Binding wounds? +--- @field public Blind fun(): number Blind? Not sure why this is a number? --- @field public Body body Body type ---- @field public bShowHelm boolean Showing Helm? ---- @field public bStationary boolean Stationary spawn? Not to be confused with "Moving" ---- @field public bTempPet boolean Is the spawn a Temporary Pet? ---- @field public Buyer boolean Is a buyer? (ie. Buyer in the bazaar) ---- @field public bWaitingForPort boolean Am I waiting to accept a port? +--- @field public bShowHelm fun(): boolean Showing Helm? +--- @field public bStationary fun(): boolean Stationary spawn? Not to be confused with "Moving" +--- @field public bTempPet fun(): boolean Is the spawn a Temporary Pet? +--- @field public Buyer fun(): boolean Is a buyer? (ie. Buyer in the bazaar) +--- @field public bWaitingForPort fun(): boolean Am I waiting to accept a port? --- @field public CachedBuff cachedbuff Caches buff information cast on others, refer to [[DataType:CachedBuff for additional information ---- @field public CachedBuffCount number Number of Buffs cached ---- @field public CanSplashLand boolean TRUE/FALSE on if a splash spell can land...NOTE! This check is ONLY for line of sight to the targetindicator (red/green circle) +--- @field public CachedBuffCount fun(): number Number of Buffs cached +--- @field public CanSplashLand fun(): boolean TRUE/FALSE on if a splash spell can land...NOTE! This check is ONLY for line of sight to the targetindicator (red/green circle) --- @field public Casting spell Spell, if currently casting (only accurate on yourself, not NPCs or other group members) ---- @field public CeilingHeightAtCurrLocation number Ceiling Height +--- @field public CeilingHeightAtCurrLocation fun(): number Ceiling Height --- @field public Class class Class ---- @field public CleanName string The "cleaned up" name ---- @field public CollisionCounter number +--- @field public CleanName fun(): string The "cleaned up" name +--- @field public CollisionCounter fun(): number --- @field public CombatSkillTicks any ---- @field public ConColor string GREY, GREEN, LIGHT BLUE, BLUE, WHITE, YELLOW, RED ---- @field public ContractorID number ---- @field public CorpseDragCount number ---- @field public CurrentEndurance number Current Endurance points (only updates when target/group) ---- @field public CurrentHPs number Current hit points ---- @field public CurrentMana number Current Mana points (only updates when target/group) ---- @field public Dead boolean Dead? +--- @field public ConColor fun(): string GREY, GREEN, LIGHT BLUE, BLUE, WHITE, YELLOW, RED +--- @field public ContractorID fun(): number +--- @field public CorpseDragCount fun(): number +--- @field public CurrentEndurance fun(): number Current Endurance points (only updates when target/group) +--- @field public CurrentHPs fun(): number Current hit points +--- @field public CurrentMana fun(): number Current Mana points (only updates when target/group) +--- @field public Dead fun(): boolean Dead? --- @field public Deity deity Deity ---- @field public DisplayName string Name displayed in game (same as EQ's %T) ---- @field public Distance number Distance from player in (x,y) ---- @field public Distance3D number Distance from player in (x,y,z) in 3D ---- @field public DistanceN number Distance from player in Y plane (North/South) ---- @field public DistancePredict number Estimated distance in (x,y), taking into account the spawn's movement speed but not the player's ---- @field public DistanceU number Distance from player in Z plane (Up/Down) ---- @field public DistanceW number Distance from player in X plane (East/West) ---- @field public DistanceX number Distance from player in X plane ---- @field public DistanceY number Distance from player in Y plane ---- @field public DistanceZ number Distance from player in Z plane ---- @field public DraggingPlayer boolean Am I currently dragging someone? ---- @field public DragNames string What are the names of the dragging players? +--- @field public DisplayName fun(): string Name displayed in game (same as EQ's %T) +--- @field public Distance fun(): number Distance from player in (x,y) +--- @field public Distance3D fun(): number Distance from player in (x,y,z) in 3D +--- @field public DistanceN fun(): number Distance from player in Y plane (North/South) +--- @field public DistancePredict fun(): number Estimated distance in (x,y), taking into account the spawn's movement speed but not the player's +--- @field public DistanceU fun(): number Distance from player in Z plane (Up/Down) +--- @field public DistanceW fun(): number Distance from player in X plane (East/West) +--- @field public DistanceX fun(): number Distance from player in X plane +--- @field public DistanceY fun(): number Distance from player in Y plane +--- @field public DistanceZ fun(): number Distance from player in Z plane +--- @field public DraggingPlayer fun(): boolean Am I currently dragging someone? +--- @field public DragNames fun(): string What are the names of the dragging players? --- @field public DoAssist fun() assists the spawn --- @field public DoFace fun() Faces target --- @field public DoTarget fun() targets spawn ---- @field public Ducking boolean Ducking? ---- @field public Equipment number returns a inttype, it takes numbers 0-8 or names: head chest arms wrists hands legs feet primary offhand ---- @field public EQLoc number Location using EQ format ---- @field public FD number ---- @field public FeetWet boolean Feet wet/swimming? ---- @field public Feigning boolean Feigning? +--- @field public Ducking fun(): boolean Ducking? +--- @field public Equipment fun(): number returns a inttype, it takes numbers 0-8 or names: head chest arms wrists hands legs feet primary offhand +--- @field public EQLoc fun(): number Location using EQ format +--- @field public FD fun(): number +--- @field public FeetWet fun(): boolean Feet wet/swimming? +--- @field public Feigning fun(): boolean Feigning? --- @field public Following spawn The spawn a player is following using /follow on - also returns your pet's target via ${Me.Pet.Following} ---- @field public Fleeing boolean Is your target moving away from you? ---- @field public FloorZ number What is the Z portion of the current location. ---- @field public Gender string Gender ---- @field public GM boolean GM or Guide? ---- @field public GMRank number GM Rank ---- @field public GroupLeader boolean Group leader? ---- @field public Guild string Guild name ---- @field public GuildStatus string Guild status (Leader, Officer, Member) NOTE GuildStatus is no longer present in BETA/TEST/LIVE versions and only available in UF and ROF EMU builds. +--- @field public Fleeing fun(): boolean Is your target moving away from you? +--- @field public FloorZ fun(): number What is the Z portion of the current location. +--- @field public Gender fun(): string Gender +--- @field public GM fun(): boolean GM or Guide? +--- @field public GMRank fun(): number GM Rank +--- @field public GroupLeader fun(): boolean Group leader? +--- @field public Guild fun(): string Guild name +--- @field public GuildStatus fun(): string Guild status (Leader, Officer, Member) NOTE GuildStatus is no longer present in BETA/TEST/LIVE versions and only available in UF and ROF EMU builds. --- @field public Heading heading Heading in this direction --- @field public HeadingTo heading Heading player must travel in to reach this spawn --- @field public HeadingToLoc heading Heading to the coordinates y,x from the spawn ---- @field public Height number Height ---- @field public Holding number Represents what the pc/npc is holding ---- @field public HoldingAnimation number ---- @field public Hovering boolean Hovering? ---- @field public ID number Spawn ID ---- @field public InPvPArea number ---- @field public Invis boolean Gives TRUE/FALSE returns. Options are:ANY or 0 - ${Me.Invis[ANY]} or ${Me.Invis[0]} or ${Me.Invis} NORMAL or 1 - ${Me.Invis[NORMAL]} or just ${Me.Invis[1]} UNDEAD or 2 - ${Me.Invis[UNDEAD]} or just ${Me.Invis[2]} ANIMAL or 3 - ${Me.Invis[ANIMAL]} or just ${Me.Invis[3]} SOS or 4 - ${Me.Invis[SOS]} or just ${Me.Invis[4]} returns true IF you are a ROG AND in fact hidden AND have a skill of at least 100 in HIDE AND have the AA for SoS" ---- @field public Invited boolean Invited to group? ---- @field public Inviter string Name of Inviter ---- @field public IsBerserk boolean Berserk? ---- @field public IsPassenger boolean Passenger? ---- @field public IsSummoned boolean Summoned? ---- @field public LastCastNum number No idea... ---- @field public LastCastTime number No idea... ---- @field public Level number Level +--- @field public Height fun(): number Height +--- @field public Holding fun(): number Represents what the pc/npc is holding +--- @field public HoldingAnimation fun(): number +--- @field public Hovering fun(): boolean Hovering? +--- @field public ID fun(): number Spawn ID +--- @field public InPvPArea fun(): number +--- @field public Invis fun(): boolean Gives TRUE/FALSE returns. Options are:ANY or 0 - ${Me.Invis[ANY]} or ${Me.Invis[0]} or ${Me.Invis} NORMAL or 1 - ${Me.Invis[NORMAL]} or just ${Me.Invis[1]} UNDEAD or 2 - ${Me.Invis[UNDEAD]} or just ${Me.Invis[2]} ANIMAL or 3 - ${Me.Invis[ANIMAL]} or just ${Me.Invis[3]} SOS or 4 - ${Me.Invis[SOS]} or just ${Me.Invis[4]} returns true IF you are a ROG AND in fact hidden AND have a skill of at least 100 in HIDE AND have the AA for SoS" +--- @field public Invited fun(): boolean Invited to group? +--- @field public Inviter fun(): string Name of Inviter +--- @field public IsBerserk fun(): boolean Berserk? +--- @field public IsPassenger fun(): boolean Passenger? +--- @field public IsSummoned fun(): boolean Summoned? +--- @field public LastCastNum fun(): number No idea... +--- @field public LastCastTime fun(): number No idea... +--- @field public Level fun(): number Level --- @field public DoLeftClick fun() left clicks the spawn ---- @field public Levitating boolean Levitating? ---- @field public LFG boolean LFG? ---- @field public Light string Name of the light class this spawn has ---- @field public LineOfSight boolean Returns TRUE if spawn is in LoS ---- @field public Linkdead boolean Linkdead? ---- @field public Loc string Loc of the spawn ---- @field public LocYX string LocYX of the spawn ---- @field public LocYXZ string LocYXZ of the spawn ---- @field public Look number Looking this angle ---- @field public Mark number Current Raid or Group marked npc mark number (raid first) +--- @field public Levitating fun(): boolean Levitating? +--- @field public LFG fun(): boolean LFG? +--- @field public Light fun(): string Name of the light class this spawn has +--- @field public LineOfSight fun(): boolean Returns TRUE if spawn is in LoS +--- @field public Linkdead fun(): boolean Linkdead? +--- @field public Loc fun(): string Loc of the spawn +--- @field public LocYX fun(): string LocYX of the spawn +--- @field public LocYXZ fun(): string LocYXZ of the spawn +--- @field public Look fun(): number Looking this angle +--- @field public Mark fun(): number Current Raid or Group marked npc mark number (raid first) --- @field public Master spawn Master, if it is charmed or a pet ---- @field public MaxEndurance number Maximum Endurance points (only updates when target/group) ---- @field public MaxHPs number Maximum hit points ---- @field public MaxMana number Maximum Mana points (only updates when target/group) ---- @field public MaxRange number The max distance from this spawn for it to hit you ---- @field public MaxRangeTo number The Max distance from this spawn for you to hit it ---- @field public MercID number +--- @field public MaxEndurance fun(): number Maximum Endurance points (only updates when target/group) +--- @field public MaxHPs fun(): number Maximum hit points +--- @field public MaxMana fun(): number Maximum Mana points (only updates when target/group) +--- @field public MaxRange fun(): number The max distance from this spawn for it to hit you +--- @field public MaxRangeTo fun(): number The Max distance from this spawn for you to hit it +--- @field public MercID fun(): number --- @field public Mount spawn Mount ---- @field public Moving boolean Moving? ---- @field public MQLoc number Location using MQ format ---- @field public Name string Name ---- @field public Named boolean Is this a "named" spawn (ie. does it's name not start with an "a" or an "an") +--- @field public Moving fun(): boolean Moving? +--- @field public MQLoc fun(): number Location using MQ format +--- @field public Name fun(): string Name +--- @field public Named fun(): boolean Is this a "named" spawn (ie. does it's name not start with an "a" or an "an") --- @field public NearestSpawn spawn Find the nearest spawn matching this Spawn Search, to this spawn (most efficient on yourself) --- @field public Next spawn Next spawn in the list --- @field public Owner spawn Owner, if mercenary --- @field public Prev spawn Previous spawn in the list --- @field public Pet pet Pet ---- @field public PctHPs number Percent hit points ---- @field public PlayerState number returns a mask as an inttype which has the following meaning:0=Idle 1=Open 2=WeaponSheathed 4=Aggressive 8=ForcedAggressive 0x10=InstrumentEquipped 0x20=Stunned 0x40=PrimaryWeaponEquipped 0x80=SecondaryWeaponEquipped ---- @field public Primary number Item ID of anything that may be in the Primary slot ---- @field public pTouchingSwitch number Have no idea what this is... +--- @field public PctHPs fun(): number Percent hit points +--- @field public PlayerState fun(): number returns a mask as an inttype which has the following meaning:0=Idle 1=Open 2=WeaponSheathed 4=Aggressive 8=ForcedAggressive 0x10=InstrumentEquipped 0x20=Stunned 0x40=PrimaryWeaponEquipped 0x80=SecondaryWeaponEquipped +--- @field public Primary fun(): number Item ID of anything that may be in the Primary slot +--- @field public pTouchingSwitch fun(): number Have no idea what this is... --- @field public Race race Race ---- @field public Roleplaying boolean Roleplaying? ---- @field public Secondary number Item ID of anything that may be in the Secondary slot ---- @field public SeeInvis number ---- @field public Sitting boolean Sitting? ---- @field public Sneaking boolean Sneaking? ---- @field public SpawnStatus number No idea ---- @field public Speed number How fast is this spawn moving ---- @field public Standing boolean Standing? ---- @field public StandState number StandState ---- @field public State string STAND, SIT, DUCK, BIND, FEIGN, DEAD, STUN, HOVER, MOUNT, UNKNOWN ---- @field public Stunned boolean Stunned? ---- @field public Stuck boolean Stuck? ---- @field public Suffix string Suffix attached to name, eg. of ---- @field public Surname string Last name ---- @field public Targetable boolean Is the spawn targetable? +--- @field public Roleplaying fun(): boolean Roleplaying? +--- @field public Secondary fun(): number Item ID of anything that may be in the Secondary slot +--- @field public SeeInvis fun(): number +--- @field public Sitting fun(): boolean Sitting? +--- @field public Sneaking fun(): boolean Sneaking? +--- @field public SpawnStatus fun(): number No idea +--- @field public Speed fun(): number How fast is this spawn moving +--- @field public Standing fun(): boolean Standing? +--- @field public StandState fun(): number StandState +--- @field public State fun(): string STAND, SIT, DUCK, BIND, FEIGN, DEAD, STUN, HOVER, MOUNT, UNKNOWN +--- @field public Stunned fun(): boolean Stunned? +--- @field public Stuck fun(): boolean Stuck? +--- @field public Suffix fun(): string Suffix attached to name, eg. of +--- @field public Surname fun(): string Last name +--- @field public Targetable fun(): boolean Is the spawn targetable? --- @field public TargetOfTarget target My targets target -----@field public TimeBeenDead number If not dead, this is some huge number. Not sure. ---- @field public Title string Prefix/Title before name ---- @field public Trader boolean Trader? ---- @field public Type string PC, NPC, Untargetable, Mount, Pet, Corpse, Chest, Trigger, Trap, Timer, Item, Mercenary, Aura, Object, Banner, Campfire, Flyer ---- @field public Underwater boolean Underwater? ---- @field public X number X coordinate ---- @field public Y number Y coordinate ---- @field public Z number Z coordinate ---- @field public N number X, the Northward-positive coordinate ---- @field public W number Y, the Westward-positive coordinate ---- @field public U number Z, the Upward-positive coordinate ---- @field public E number Shortcut for -X (makes Eastward positive) ---- @field public S number Shortcut for -Y (makes Southward positive) ---- @field public D number Shortcut for -Z (makes Downward positive) +----@field public TimeBeenDead fun(): number If not dead, this is some huge fun(): number. Not sure. +--- @field public Title fun(): string Prefix/Title before name +--- @field public Trader fun(): boolean Trader? +--- @field public Type fun(): string PC, NPC, Untargetable, Mount, Pet, Corpse, Chest, Trigger, Trap, Timer, Item, Mercenary, Aura, Object, Banner, Campfire, Flyer +--- @field public Underwater fun(): boolean Underwater? +--- @field public X fun(): number X coordinate +--- @field public Y fun(): number Y coordinate +--- @field public Z fun(): number Z coordinate +--- @field public N fun(): number X, the Northward-positive coordinate +--- @field public W fun(): number Y, the Westward-positive coordinate +--- @field public U fun(): number Z, the Upward-positive coordinate +--- @field public E fun(): number Shortcut for -X (makes Eastward positive) +--- @field public S fun(): number Shortcut for -Y (makes Southward positive) +--- @field public D fun(): number Shortcut for -Z (makes Downward positive) --- @field public FindBuff fun(predicate: string): spell Try find a given buff/debuff given predicate from cachedbuffs --- @field public Aggresive fun(): boolean Is the spawn agressive towards you \ No newline at end of file diff --git a/datatype/_spell.lua b/datatype/_spell.lua index 8080579..e9685b4 100644 --- a/datatype/_spell.lua +++ b/datatype/_spell.lua @@ -1,44 +1,44 @@ --- @class spell --- @field public AERange float AE range (group spells use this for their range) ---- @field public CastOnAnother string Message when cast on others ---- @field public CastOnYou string Message when cast on yourself +--- @field public CastOnAnother fun(): string Message when cast on others +--- @field public CastOnYou fun(): string Message when cast on yourself --- @field public CastTime timestamp Cast time (unadjusted) ---- @field public CounterType string The resist counter. Will be one of "Disease", "Poison", "Curse" or "Corruption" ---- @field public CounterNumber number The number of counters that the spell adds +--- @field public CounterType fun(): string The resist counter. Will be one of "Disease", "Poison", "Curse" or "Corruption" +--- @field public CounterNumber fun(): integer The number of counters that the spell adds --- @field public Duration ticks Duration of the spell (if any) --- @field public DurationValue1 ticks Duration of the spell (if any) --- @field public FizzleTime timestamp Time to recover after fizzle ---- @field public GemIcon number Icon number of the spell. Exmaple ${Spell[blah].GemIcon} ---- @field public HastePct number Percentage of haste, example of use ${Me.Hasted.HastePct} or ${Spell[Speed of Milyex].HastePct} +--- @field public GemIcon fun(): integer Icon number of the spell. Exmaple ${Spell[blah].GemIcon} +--- @field public HastePct fun(): number Percentage of haste, example of use ${Me.Hasted.HastePct} or ${Spell[Speed of Milyex].HastePct} --- @field public ID number Spell ID ---- @field public IsSkill boolean is this spell a skill? ---- @field public IsSwarmSpell boolean Is this spell a Swarm spell? ---- @field public Level number Level ---- @field public Location number Appears to be max distance ---- @field public Mana number Mana cost (unadjusted) +--- @field public IsSkill fun(): boolean is this spell a skill? +--- @field public IsSwarmSpell fun(): boolean Is this spell a Swarm spell? +--- @field public Level fun(): integer Level +--- @field public Location fun(): number Appears to be max distance +--- @field public Mana fun(): integer Mana cost (unadjusted) --- @field public MyCastTime timestamp Adjusted cast time --- @field public MyRange float Adjusted spell range, including focus effects, etc. ---- @field public Name string Spell Name +--- @field public Name fun(): string Spell Name --- @field public PushBack float Push back amount --- @field public Range float Maximum range to target (use AERange for AE and group spells) ---- @field public Rank number Returns either 1, 2 or 3 for spells and 4-30 for clickys and potions. ---- @field public RankName string Returns the spell/combat ability name rank character has. ---- @field public ReagentCount int Number of reagents used for this spell ---- @field public ReagentID int ID of the reagent item used for this spell ---- @field public RecastTime float Time to recast after successful cast +--- @field public Rank fun(): integer Returns either 1, 2 or 3 for spells and 4-30 for clickys and potions. +--- @field public RankName fun(): string Returns the spell/combat ability name rank character has. +--- @field public ReagentCount fun(): integer Number of reagents used for this spell +--- @field public ReagentID fun(): integer ID of the reagent item used for this spell +--- @field public RecastTime fun(): number Time to recast after successful cast --- @field public RecoveryTime timestamp Same as FizzleTime ---- @field public ResistAdj number Resist adjustment ---- @field public ResistType string See below for Resist Types ---- @field public Skill string See below for Skill Types ---- @field public SlowPct number Percentage of slow, example of use ${Target.Slowed.SlowPct} or ${Spell[Slowing Helix].SlowPct} ---- @field public SpellIcon number Icon number of the spell. Exmaple ${Spell[blah].SpellIcon} ---- @field public SpellType string The spell type, Will be one of "Beneficial(Group)", "Beneficial", "Detrimental" or "Unknown" ---- @field public Stacks boolean Does the selected spell stack with your current buffs (duration is in ticks) ---- @field public StacksPet boolean Does the selected spell stack with your pet's current buffs (duration is in ticks) ---- @field public StacksTarget boolean Does the selected spell stack with your target's current buffs (duration is in ticks) ---- @field public StacksWith boolean alias for .WillStack - see entry for more details +--- @field public ResistAdj fun(): integer Resist adjustment +--- @field public ResistType fun(): string See below for Resist Types +--- @field public Skill fun(): string See below for Skill Types +--- @field public SlowPct fun(): number Percentage of slow, example of use ${Target.Slowed.SlowPct} or ${Spell[Slowing Helix].SlowPct} +--- @field public SpellIcon fun(): integer Icon number of the spell. Exmaple ${Spell[blah].SpellIcon} +--- @field public SpellType fun(): string The spell type, Will be one of "Beneficial(Group)", "Beneficial", "Detrimental" or "Unknown" +--- @field public Stacks fun(): boolean Does the selected spell stack with your current buffs (duration is in ticks) +--- @field public StacksPet fun(): boolean Does the selected spell stack with your pet's current buffs (duration is in ticks) +--- @field public StacksTarget fun(): boolean Does the selected spell stack with your target's current buffs (duration is in ticks) +--- @field public StacksWith fun(): boolean alias for .WillStack - see entry for more details --- @field public NewStacks fun(): boolean see entry for more details ---- @field public TargetType string See below for Target Types ---- @field public WearOff string The "wear off" message ---- @field public WillStack boolean Does the selected spell stack with the specific SPELL nameDOES NOT work with AAs. ---- @field public ToString string Same as Name \ No newline at end of file +--- @field public TargetType fun(): string See below for Target Types +--- @field public WearOff fun(): string The "wear off" message +--- @field public WillStack fun(): boolean Does the selected spell stack with the specific SPELL nameDOES NOT work with AAs. +--- @field public ToString fun(): string Same as Name \ No newline at end of file diff --git a/datatype/_target.lua b/datatype/_target.lua index 5945176..71e9b74 100644 --- a/datatype/_target.lua +++ b/datatype/_target.lua @@ -3,17 +3,17 @@ --- @field public AggroHolder spawn Returns the target's current target. --- @field public Beneficial spell Returns the name of the Beneficial spell if the Target has one. This will skip "player" casted buffs, but will show NPC Casted buffs and some AA buffs. --- @field public Buff spell Returns the target's spell by buff index number or the first buff if no Index is provided. ---- @field public BuffCount number Returns the number of buffs on the target. +--- @field public BuffCount fun(): integer Returns the number of buffs on the target. --- @field public BuffDuration timestamp Returns the duration remaining on this target buff by index number or by spell name ---- @field public BuffsPopulated boolean Returns TRUE when the target's buffs are finished populating. +--- @field public BuffsPopulated fun(): boolean Returns TRUE when the target's buffs are finished populating. --- @field public Brells spell Returns the name of the Brells spell if the Target has one --- @field public Charmed spell Returns the name of the Charmed spell if the Target has one --- @field public Clarity spell Returns the name of the Clarity spell if the Target has one --- @field public Corrupted spell Returns the name of any the Corruption spell if Target has one --- @field public Cursed spell Returns the name of the Curse spell if Target has one --- @field public Crippled spell Returns the name of the Cripple spell if the Target has one ---- @field public Diseased string Returns the name of a Disease spell if the Target has one ---- @field public Dotted string Returns the name of a DOT spell if the Target has one +--- @field public Diseased fun(): string Returns the name of a Disease spell if the Target has one +--- @field public Dotted fun(): string Returns the name of a DOT spell if the Target has one --- @field public DSed spell Returns the name of the Damage Shield spell if the Target has one --- @field public Focus spell Returns the name of the Focus spell if the Target has one --- @field public Growth spell Returns the name of the Growth spell if the Target has one @@ -21,7 +21,7 @@ --- @field public HybridHP spell Returns the name of the Hybrid HP spell if the Target has one --- @field public Maloed spell Returns the name of the Malo spell if the Target has one --- @field public Mezzed spell Returns the name of the Mez spell if the Target has one ---- @field public Poisoned string Returns the name of a Poison spell if the Target has one +--- @field public Poisoned fun(): string Returns the name of a Poison spell if the Target has one --- @field public Pred spell Returns the name of the Predator spell if the Target has one --- @field public Rooted spell Returns the name of the Rooted spell if the Target has one --- @field public Regen spell Returns the name of the Regen spell if the Target has one diff --git a/datatype/_ticks.lua b/datatype/_ticks.lua index 9724175..81bb2c3 100644 --- a/datatype/_ticks.lua +++ b/datatype/_ticks.lua @@ -1,10 +1,10 @@ --- @class ticks ---- @field public Hours number The number of hours in HH:MM:SS (0-23) ---- @field public Minutes number The number of minutes in HH:MM:SS (1-59) ---- @field public Seconds number The number of seconds in HH:MM:SS (1-59) ---- @field public TotalMinutes number The total number of minutes ---- @field public TotalSeconds number The total number of seconds ---- @field public Ticks number The value in ticks ---- @field public Time string Time in the form MM:SS ---- @field public TimeHMS string Time in the form HH:MM:SS (if there are no hours, the form will be MM:SS) ---- @field public ToString string Same as Ticks \ No newline at end of file +--- @field public Hours fun(): integer The number of hours in HH:MM:SS (0-23) +--- @field public Minutes fun(): integer The number of minutes in HH:MM:SS (1-59) +--- @field public Seconds fun(): integer The number of seconds in HH:MM:SS (1-59) +--- @field public TotalMinutes fun(): integer The total number of minutes +--- @field public TotalSeconds fun(): integer The total number of seconds +--- @field public Ticks fun(): integer The value in ticks +--- @field public Time fun(): string Time in the form MM:SS +--- @field public TimeHMS fun(): string Time in the form HH:MM:SS (if there are no hours, the form will be MM:SS) +--- @field public ToString fun(): string Same as Ticks \ No newline at end of file diff --git a/datatype/_timestamp.lua b/datatype/_timestamp.lua index 555d184..d51966d 100644 --- a/datatype/_timestamp.lua +++ b/datatype/_timestamp.lua @@ -1,12 +1,12 @@ --- @class timestamp ---- @field public Hours number Number of hours in the timestamp (1hr 23min 53 seconds will return 1) ---- @field public Minutes number Number of Minutes in the timestamp (1hr 23min 53 seconds will return 23) ---- @field public Seconds number Number of Seconds in the timestamp (1hr 23min 53 seconds will return 53) ---- @field public TimeHMS string Time value formatted in H:M:S ---- @field public Time string Time value formatted in M:S ---- @field public TotalMinutes number Total number of minutes in the timestamp (1hr 23min 53 seconds will return 83) ---- @field public TotalSeconds number Total number of minutes in the timestamp (1hr 23min 53 seconds will return 5033) ---- @field public Raw number Time value represented in milliseconds +--- @field public Hours fun(): integer Number of hours in the timestamp (1hr 23min 53 seconds will return 1) +--- @field public Minutes fun(): integer Number of Minutes in the timestamp (1hr 23min 53 seconds will return 23) +--- @field public Seconds fun(): integer Number of Seconds in the timestamp (1hr 23min 53 seconds will return 53) +--- @field public TimeHMS fun(): string Time value formatted in H:M:S +--- @field public Time fun(): string Time value formatted in M:S +--- @field public TotalMinutes fun(): integer Total number of minutes in the timestamp (1hr 23min 53 seconds will return 83) +--- @field public TotalSeconds fun(): integer Total number of minutes in the timestamp (1hr 23min 53 seconds will return 5033) +--- @field public Raw fun(): number Time value represented in milliseconds --- @field public Float float timestamp represented in seconds (1hr 23 min 53 seconds will return 5033.00) ---- @field public Ticks number Time value represented in ticks ---- @field public ToString string Same as Raw \ No newline at end of file +--- @field public Ticks fun(): integer Time value represented in ticks +--- @field public ToString fun(): string Same as Raw \ No newline at end of file diff --git a/datatype/_window.lua b/datatype/_window.lua index 2813d05..8723940 100644 --- a/datatype/_window.lua +++ b/datatype/_window.lua @@ -1,46 +1,47 @@ --- @class window --- @field public BGColor argb Background color ---- @field public Checked boolean Returns TRUE if the button has been checked +--- @field public Checked fun(): boolean Returns TRUE if the button has been checked --- @field public Child window Child with this name ---- @field public Children boolean Returns TRUE if the window has children +--- @field public Children fun(): boolean Returns TRUE if the window has children --- @field public DoClose fun() Does the action of closing a window --- @field public DoOpen fun() Does the action of opening a window ---- @field public Enabled boolean Returns TRUE if the window is enabled +--- @field public Enabled fun(): boolean Returns TRUE if the window is enabled --- @field public FirstChild window First child window ---- @field public Height number Height in pixels +--- @field public Height fun(): number Height in pixels --- @field public Highlighted boolean Returns TRUE if the window is highlighted --- @field public HisTradeReady boolean Has the other person clicked the Trade button? ---- @field public HScrollMax number Horizontal scrollbar range ---- @field public HScrollPos number Horizontal scrollbar position ---- @field public HScrollPct number Horizontal scrollbar position in % to range from 0 to 100 ---- @field public Items number Number of items in a Listbox or Combobox +--- @field public HScrollMax fun(): number Horizontal scrollbar range +--- @field public HScrollPos fun(): number Horizontal scrollbar position +--- @field public HScrollPct fun(): number Horizontal scrollbar position in % to range from 0 to 100 +--- @field public Items fun(): number Number of items in a Listbox or Combobox --- @field public LeftMouseDown fun() Does the action of clicking the left mouse button down --- @field public LeftMouseHeld fun() Does the action of holding the left mouse button --- @field public LeftMouseHeldUp fun() does the action of holding the left mouse button up --- @field public LeftMouseUp fun() Does the action of clicking the left mouse button up ---- @field public List string Get the text for the #th item in a list box. Only works on list boxes. Use of ,y is optional and allows selection of the column of the window to get text from or Find an item in a list box by partial match (use window.List[=text] for exact). Only works on list boxes. Use of ,y is optional and allows selection of the column of the window to search in. ---- @field public Minimized boolean Returns TRUE if the window is minimized ---- @field public MouseOver boolean Returns TRUE if the mouse is currently over the window ---- @field public MyTradeReady boolean Have I clicked the Trade button? ---- @field public Name string Name of window piece, e.g. "ChatWindow" for top level windows, or the piece name for child windows. Note: this is Custom UI dependent +--- @field public List fun(): string Get the text for the #th item in a list box. Only works on list boxes. Use of ,y is optional and allows selection of the column of the window to get text from or Find an item in a list box by partial match (use window.List[=text] for exact). Only works on list boxes. Use of ,y is optional and allows selection of the column of the window to search in. +--- @field public Minimized fun(): boolean Returns TRUE if the window is minimized +--- @field public MouseOver fun(): boolean Returns TRUE if the mouse is currently over the window +--- @field public MyTradeReady fun(): boolean Have I clicked the Trade button? +--- @field public Name fun(): string Name of window piece, e.g. "ChatWindow" for top level windows, or the piece name for child windows. Note: this is Custom UI dependent --- @field public Next window Next sibling window ---- @field public Open boolean Returns TRUE if the window is open +--- @field public Open fun(): boolean Returns TRUE if the window is open --- @field public Parent window Parent window --- @field public RightMouseDown fun() does the action of clicking the right mouse button --- @field public RightMouseHeld fun() Does the action of holding the right mouse button --- @field public RightMouseHeldUp fun() Does the action of holding the right mouse button up --- @field public RightMouseUp fun() Does the action of clicking the right mouse button up --- @field public Select fun() Selects the specified window ---- @field public ScreenID string ScreenID of window piece. Note: This is not Custom UI dependent, it must be the same on all UIs ---- @field public Siblings boolean Returns TRUE if the window has siblings ---- @field public Style number Window style code ---- @field public Text string Window's text ---- @field public Tooltip string TooltipReference text ---- @field public Type string Type of window piece (Screen for top level windows, or Listbox, Button, Gauge, Label, Editbox, Slider, etc) ---- @field public VScrollMax number Vertical scrollbar range ---- @field public VScrollPct number Vertical scrollbar position in % to range from 0 to 100 ---- @field public VScrollPos number Vertical scrollbar position ---- @field public Width number Width in pixels ---- @field public X number Screen X position ---- @field public Y number Screen Y position ---- @field public ToString boolean TRUE if window exists, FALSE if not \ No newline at end of file +--- @field public ScreenID fun(): string ScreenID of window piece. Note: This is not Custom UI dependent, it must be the same on all UIs +--- @field public Siblings fun(): boolean Returns TRUE if the window has siblings +--- @field public Style fun(): number Window style code +--- @field public Text fun(): string Window's text +--- @field public Tooltip fun(): string TooltipReference text +--- @field public Type fun(): string Type of window piece (Screen for top level windows, or Listbox, Button, Gauge, Label, Editbox, Slider, etc) +--- @field public VScrollMax fun(): number Vertical scrollbar range +--- @field public VScrollPct fun(): number Vertical scrollbar position in % to range from 0 to 100 +--- @field public VScrollPos fun(): number Vertical scrollbar position +--- @field public Width fun(): number Width in pixels +--- @field public X fun(): number Screen X position +--- @field public Y fun(): number Screen Y position +--- @field public ToString fun(): boolean TRUE if window exists, FALSE if not + diff --git a/datatype/_xtarget.lua b/datatype/_xtarget.lua index a28a12f..cd98019 100644 --- a/datatype/_xtarget.lua +++ b/datatype/_xtarget.lua @@ -1,6 +1,6 @@ --- @class xtarget ---- @field public ID number ID of specified XTarget ---- @field public Name string Name of specified XTarget ---- @field public PctAggro number PctAggro of specified XTarget ---- @field public TargetType string Extended target type ---- @field public ToString number Number of current extended targets \ No newline at end of file +--- @field public ID fun(): integer ID of specified XTarget +--- @field public Name fun(): string Name of specified XTarget +--- @field public PctAggro fun(): number PctAggro of specified XTarget +--- @field public TargetType fun(): string Extended target type +--- @field public ToString fun(): string Number of current extended targets \ No newline at end of file diff --git a/mq.lua b/mq.lua index 0b86876..8ebe61a 100644 --- a/mq.lua +++ b/mq.lua @@ -64,6 +64,10 @@ function mq.getAllSpawns() end ---@return spawn[] The spawns function mq.getFilteredSpawns(predicate) end +---@param type any # The variable we want to check type of +---@return mqtype +function mq.gettype(type) end + ---@class Cmd ---@field afk fun() ---@field alt fun() @@ -170,28 +174,28 @@ function TLO.Bool() end ---@param index integer ---@param filter string ----@return spawn +---@return spawn | fun(): string|nil ---@overload fun(filter: string): spawn function TLO.NearestSpawn(index, filter)end ---Finds an Item by the item ID ---@param id integer ----@return item +---@return item | fun(): string|nil function mq.TLO.FindItem(id)end ----Finds an Item by the item Name +---Finds an Item by the partial item Name (use of '=' infront of name forces exact match) ---@param name string ----@return item +---@return item | fun(): string|nil function mq.TLO.FindItem(name)end ---Finds an Item in the bank by the item ID ---@param id integer ----@return item +---@return item | fun(): string|nil function mq.TLO.FindItemBank(id)end ----Finds an Item in the bank by the item Name +---Finds an Item in the bank by the partial item Name (use of '=' infront of name forces exact match) ---@param name string ----@return item +---@return item | fun(): string|nil function mq.TLO.FindItemBank(name)end ---Return a counts of Items by the item ID @@ -245,12 +249,12 @@ function mq.TLO.Plugin(name)end ---Returns a Spawn by ID ---@param id integer ----@return spawn +---@return spawn | fun(): string|nil function mq.TLO.Spawn(id)end ----Returns a Spawn by use of a [Spawn Search](https://docs.macroquest.org/reference/general/spawn-search/) filter ---@param filter string ----@return spawn +---@return spawn | fun(): string|nil function mq.TLO.Spawn(filter)end ---Number of items on the ground in this zone (filter is optional) @@ -265,12 +269,12 @@ function mq.TLO.SpawnCount(filter)end ---Returns a Spell by ID ---@param id integer ----@return spell +---@return spell | fun(): string|nil function mq.TLO.Spell(id)end ----Returns a Spell by Name ---@param name string ----@return spell +---@return spell | fun(): string|nil function mq.TLO.Spell(name)end ---Returns a Skill by number @@ -291,12 +295,12 @@ TLO.Zone = nil ---@diagnostic disable: assign-type-mismatch ----Retrieves information about a zone by zone ID. If this zone is the current zone, then this will return currentzone. ---@param id integer Zone ID ----@return zone|nil +---@return zone|fun(): string | nil function TLO.Zone(id) end ----Retrieves information about a zone by short name. If this zone is the current zone, then this will return currentzone. ---@param shortName string Zone Short Name ----@return zone|nil +---@return zone|fun(): string | nil function TLO.Zone(shortName) end ---@diagnostic enable: assign-type-mismatch ---@diagnostic enable: duplicate-set-field diff --git a/plugins/DanNet/_TLO.lua b/plugins/DanNet/_TLO.lua new file mode 100644 index 0000000..ac58c35 --- /dev/null +++ b/plugins/DanNet/_TLO.lua @@ -0,0 +1,67 @@ +---@meta + +--- DanNet Lua Bindings +---@class TLO.DanNet +---@field Name fun(): string # Current node name (fully qualified) +---@field Version fun(): string # Current build version +---@field Debug fun(): string # Debugging flag +---@field LocalEcho fun(): string # Local echo flag (outgoing echo) +---@field CommandEcho fun(): string # Command echo (incoming commands) +---@field FullNames fun(): string # Print fully qualified names? +---@field FrontDelim fun(): string # Use a front | in arrays? +---@field Timeout fun(): string # Timeout for implicit delay in /dquery and /dobserve commands +---@field ObserveDelay fun(): string # Delay between observe broadcasts (in ms) +---@field Evasive fun(): string # Time to classify a peer as evasive (in ms) +---@field Expired fun(): string # Keepalive time for non-responding peers (in ms) +---@field Keepalive fun(): string # Keepalive time for local actor pipe (in ms) +---@field PeerCount fun(): string # Number of connected peers +---@field Peers fun(): string # List of connected peers +---@field GroupCount fun(): string # Number of all groups +---@field Groups fun(): string # List of all groups +---@field JoinedCount fun(): string # Number of joined groups +---@field Joined fun(): string # List of joined groups +TLO.DanNet = {} + +---@param peerName string +---@return peer|fun(): string|nil +function TLO.DanNet(peerName) end + +---@param groupName string +---@return string # all peers in the [groupName] group +function TLO.DanNet.Peers(groupName) end + +---- Observe accessor +---@return string # List all queries observers have registered +function TLO.DanNet.O() end + +---- Observe accessor +---@return string # List all queries that self has registered on peer +function TLO.DanNet.Observe() end + +---- Observe accessor +---@param query string +---@return string # Lists all peers that have registered that query as an observer on self +function TLO.DanNet.O(query) end + +---- Observe accessor +---@param query string +---@return string # Lists all peers that have registered that query as an observer on self +function TLO.DanNet.Observe(query) end + +---@return integer # Count observed data on self +function TLO.DanNet.OCount() end + +---@return integer # Count observed data on self +function TLO.DanNet.ObserveCount() end + +---@return boolean # Determine if query has been set as observed data on self +function TLO.DanNet.OSet() end + +---@return boolean # Determine if query has been set as observed data on self +function TLO.DanNet.ObserveSet() end + +---@return observer # Last executed query +function TLO.DanNet.Q() end + +---@return observer # Last executed query +function TLO.DanNet.Query() end \ No newline at end of file diff --git a/plugins/DanNet/_datatypes.lua b/plugins/DanNet/_datatypes.lua new file mode 100644 index 0000000..45ef54c --- /dev/null +++ b/plugins/DanNet/_datatypes.lua @@ -0,0 +1,45 @@ +---@class observer +---@field Received fun(): integer # The last received timestamp, or 0 for never received + +---@class peer +peer = nil + +---- Observe accessor +---@return string # List all queries that self has registered on peer +function peer.O() end + +---- Observe accessor +---@return string # List all queries that self has registered on peer +function peer.Observe() end + +---- Observe accessor +---@param query string +---@return string # attempt to retrieve the data specified on the remote peer +function peer.O(query) end + +---- Observe accessor +---@param query string +---@return observer | fun(): string # Attempt to retrieve the data specified on the remote peer +function peer.Observe(query) end + +---@return integer # Count observed data on peer +function peer.OCount() end + +---@return integer # Count observed data on peer +function peer.ObserveCount() end + +---@param query string +---@return boolean # Determine if query has been set as observed data on peer +function peer.OSet(query) end + +---@param query string +---@return boolean # Determine if query has been set as observed data on peer +function peer.ObserveSet(query) end + +---@param query string +---@return observer | fun(): string # Last executed query +function peer.Q(query) end + +---@param query string +---@return observer | fun(): string # Last executed query +function peer.Query(query) end \ No newline at end of file diff --git a/plugins/NetBots/_TLO.lua b/plugins/NetBots/_TLO.lua index bf680fb..546dc54 100644 --- a/plugins/NetBots/_TLO.lua +++ b/plugins/NetBots/_TLO.lua @@ -2,7 +2,7 @@ --- NetBots Lua Bindings ---@class TLO.NetBots ----@field Client fun(index: integer): netbot The netbot at the given index in the array +---@field Client fun(index: integer): string The name of 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.