Skip to content

Commit

Permalink
Add lua function calls for lua variable
Browse files Browse the repository at this point in the history
  • Loading branch information
projecteon committed Sep 14, 2022
1 parent a89a961 commit 2ea97c1
Show file tree
Hide file tree
Showing 6 changed files with 88 additions and 87 deletions.
62 changes: 31 additions & 31 deletions 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
--- @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
10 changes: 5 additions & 5 deletions datatype/_target.lua
Expand Up @@ -3,25 +3,25 @@
--- @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
--- @field public Hasted spell Returns the name of the Haste spell if the Target has one
--- @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
Expand Down
18 changes: 9 additions & 9 deletions 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
--- @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
20 changes: 10 additions & 10 deletions 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
--- @field public Ticks fun(): integer Time value represented in ticks
--- @field public ToString fun(): string Same as Raw
55 changes: 28 additions & 27 deletions 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
--- @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

10 changes: 5 additions & 5 deletions 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
--- @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

0 comments on commit 2ea97c1

Please sign in to comment.