Merge pull request #9 from projecteon/master

Update type defs + add plugins

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"
+  ],
+}
+```

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)
+--- @field public Type fun(): number Type (1-6)

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
+--- @field public ToString fun(): string Same as Name

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
+--- @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