commit c8d4f32d5dd405ba843f49fcbb62409588d05c55 Author: PhatPhuckDave Date: Mon Dec 16 13:13:08 2024 +0100 Initial commit diff --git a/Color.lua b/Color.lua new file mode 100644 index 0000000..e5a2176 --- /dev/null +++ b/Color.lua @@ -0,0 +1,4 @@ +---@meta + +---r,g,b,a +---@alias wowColor table \ No newline at end of file diff --git a/LCG.lua b/LCG.lua new file mode 100644 index 0000000..42440c5 --- /dev/null +++ b/LCG.lua @@ -0,0 +1,45 @@ +---@meta + +---@class LCG +LCG = { + ---@param frame Frame target frame to set glowing; + ---@param color? wowColor {r,g,b,a}, color of lines and opacity, from 0 to 1. Defaul value is {0.95, 0.95, 0.32, 1}; + ---@param n? number number of lines. Defaul value is 8; + ---@param frequency? number frequency, set to negative to inverse direction of rotation. Default value is 0.25; + ---@param length? number length of lines. Default value depends on region size and number of lines; + ---@param th? number thickness of lines. Default value is 2; + ---@param xoffset? number offset of glow relative to region border; + ---@param yoffset? number offset of glow relative to region border; + ---@param border? number set to true to create border under lines; + ---@param key? string key of glow, allows for multiple glows on one frame; + ---@return nil + PixelGlow_Start = function(frame, color, n, frequency, length, th, xoffset, yoffset, border, key) end, + ---@param frame Frame target frame to stop glowing; + ---@param key? string key of glow, allows for multiple glows on one frame; + ---@return nil + PixelGlow_Stop = function(frame, key) end, + + ---@param frame Frame target frame to set glowing; + ---@param color? wowColor {r,g,b,a}, color of lines and opacity, from 0 to 1. Defaul value is {0.95, 0.95, 0.32, 1}; + ---@param n? number number of lines. Defaul value is 4; + ---@param frequency? number frequency, set to negative to inverse direction of rotation. Default value is 0.125; + ---@param scale? number scale of particles; + ---@param xoffset? number offset of glow relative to region border; + ---@param yoffset? number offset of glow relative to region border; + ---@param key? string key of glow, allows for multiple glows on one frame; + ---@return nil + AutoCastGlow_Start = function(frame, color, n, frequency, scale, xoffset, yoffset, key) end, + ---@param frame Frame target frame to stop glowing; + ---@param key? string key of glow, allows for multiple glows on one frame; + ---@return nil + AutoCastGlow_Stop = function(frame, key) end, + + ---@param frame Frame target frame to set glowing; + ---@param color? wowColor {r,g,b,a}, color of lines and opacity, from 0 to 1. Defaul value is {0.95, 0.95, 0.32, 1}; + ---@param frequency? number frequency, set to negative to inverse direction of rotation. Default value is 0.125; + ---@return nil + ButtonGlow_Start = function(frame, color, frequency) end, + ---@param frame Frame target frame to set glowing; + ---@return nil + ButtonGlow_Stop = function(frame) end, +} diff --git a/UnitDebuff.lua b/UnitDebuff.lua new file mode 100644 index 0000000..ace33b8 --- /dev/null +++ b/UnitDebuff.lua @@ -0,0 +1,16 @@ +---@meta + +---@param unitId string +---@param index string|number index or name of debuff to query +---@param removable? boolean If 1, only debuffs removable by player will be returned; debuffIndex still begins at 1. +---@return string name The name of the spell or effect of the debuff, or nil if no debuff was found with the specified name or at the specified index. This is the name shown in yellow when you mouse over the icon. +---@return string icon The identifier of (path and filename to) the indicated debuff, or nil if no debuff +---@return number count The number of times the debuff has been applied to the target. Returns 0 for any debuff which doesn't stack. +---@return string debuffType The type of debuff, e.g. "Magic", "Disease", "Poison", "Curse", or "none". Returns nil if the debuff type is not known. +---@return number duration The full duration of the debuff in seconds; nil if the debuff was not cast by the player. +---@return number expirationTime Time at which the debuff expires (GetTime() as a reference frame). +---@return string unitCaster Reference to the unit that cast the buff/debuff. +---@return boolean isStealable 1 if it is stealable otherwise nil +---@return boolean shouldConsolidate 1 if the buff should be placed in a buff consolidation box (usually long-term effects). +---@return number spellId spell ID of the aura. +UnitDebuff = function(unitId, index, removable) end diff --git a/allstates.lua b/allstates.lua new file mode 100644 index 0000000..a59b7f3 --- /dev/null +++ b/allstates.lua @@ -0,0 +1,22 @@ +---@meta + +---[Source](https://github.com/WeakAuras/WeakAuras2/wiki/Trigger-State-Updater-%28TSU%29) +---@class state +---@field changed boolean Informs WeakAuras that the states values have changed. Always set this to true for states that were changed. +---@field show boolean Controls whether the display is visible. Note, that states that have show set to false are automatically removed. +---@field name string The name, returned by %n +---@field icon number|string IconID or TexturePath, used in icons and progress bars +---@field texture number|string IconID or TexturePath, used in textures +---@field stacks number The stack count, returned by %s +---@field index number|string Sets the order the output will display in a dynamic group (if sorting is set to "none" on the group). Strings or numbers are fine but DO NOT MIX TYPES! +---@field progressType string "timed" or "static" +---@field expirationTime number Use with "timed" progressType; relative to GetTime() +---@field duration number Use with "timed" progressType; total duration of the bar in seconds +---@field value number Use with "static" progressType +---@field maxValue number Use with "static" progressType +---@field autoHide boolean Set to true to make the display automatically hide at the end of the "timed" progress. autoHide can also be used along with the "static" progressType by defining a duration and expirationTime along with the static value and total. While the static values will be displayed, the timed values will set the Hide time for the clone. +---@field paused boolean Set to true (and set a remaining value) to pause a "timed" progress. Set to false (and recalculate the expirationTime value) to resume. +---@field remaining number Only used with paused, gives WA the info needed to show paused progress at the current point. +state = {} + +---@alias allstates table \ No newline at end of file diff --git a/api/AbandonQuest.lua b/api/AbandonQuest.lua new file mode 100644 index 0000000..8f658bf --- /dev/null +++ b/api/AbandonQuest.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Confirms abandoning a quest. Use SetAbandonQuest() first to select the quest to abandon. +function AbandonQuest() end \ No newline at end of file diff --git a/api/AbandonSkill.lua b/api/AbandonSkill.lua new file mode 100644 index 0000000..9e64029 --- /dev/null +++ b/api/AbandonSkill.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Unlearns a skill (used only for professions) +function AbandonSkill(index) end \ No newline at end of file diff --git a/api/AcceptAreaSpiritHeal.lua b/api/AcceptAreaSpiritHeal.lua new file mode 100644 index 0000000..4503854 --- /dev/null +++ b/api/AcceptAreaSpiritHeal.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Accepts the next upcoming periodic resurrection from a battleground spirit healer. Automatically called in the default UI in response to the AREA_SPIRIT_HEALER_IN_RANGE event which fires when the player's ghost is near a battleground spirit healer. +function AcceptAreaSpiritHeal() end \ No newline at end of file diff --git a/api/AcceptBattlefieldPort.lua b/api/AcceptBattlefieldPort.lua new file mode 100644 index 0000000..129a86b --- /dev/null +++ b/api/AcceptBattlefieldPort.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param accept 1nil +---Accepts the offered teleport to a battleground/arena or leaves the battleground/arena or queue. This function requires a hardware event when used to accept a teleport; it can be called without a hardware event for leaving a battleground/arena or its queue. +function AcceptBattlefieldPort(index, accept) end \ No newline at end of file diff --git a/api/AcceptDuel.lua b/api/AcceptDuel.lua new file mode 100644 index 0000000..cb97ab4 --- /dev/null +++ b/api/AcceptDuel.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Accepts a proposed duel +function AcceptDuel() end \ No newline at end of file diff --git a/api/AcceptGroup.lua b/api/AcceptGroup.lua new file mode 100644 index 0000000..dcdeac2 --- /dev/null +++ b/api/AcceptGroup.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Accepts an invitation to join a party or raid. Usable in response to the PARTY_INVITE_REQUEST event which fires when the player is invited to join a group. This function does not automatically hide the default UI's group invite dialog; doing such requires calling StaticPopup_Hide("PARTY_INVITE"), but only after the PARTY_MEMBERS_CHANGED event fires indicating the player has successfully joined the group. +function AcceptGroup() end \ No newline at end of file diff --git a/api/AcceptGuild.lua b/api/AcceptGuild.lua new file mode 100644 index 0000000..6e0e05a --- /dev/null +++ b/api/AcceptGuild.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Accepts an invitation to join a guild. Usable in response to the GUILD_INVITE_REQUEST event, which fires when the player is invited to join a guild. +function AcceptGuild() end \ No newline at end of file diff --git a/api/AcceptLevelGrant.lua b/api/AcceptLevelGrant.lua new file mode 100644 index 0000000..be50677 --- /dev/null +++ b/api/AcceptLevelGrant.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Accepts a level offered by the player's Recruit-a-Friend partner +function AcceptLevelGrant() end \ No newline at end of file diff --git a/api/AcceptProposal.lua b/api/AcceptProposal.lua new file mode 100644 index 0000000..6872838 --- /dev/null +++ b/api/AcceptProposal.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Accepts a LFG dungeon invite. +function AcceptProposal() end \ No newline at end of file diff --git a/api/AcceptQuest.lua b/api/AcceptQuest.lua new file mode 100644 index 0000000..8e98591 --- /dev/null +++ b/api/AcceptQuest.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Accepts the quest offered by a questgiver. Usable following the QUEST_DETAIL event in which the questgiver presents the player with the details of a quest and the option to accept or decline. +function AcceptQuest() end \ No newline at end of file diff --git a/api/AcceptResurrect.lua b/api/AcceptResurrect.lua new file mode 100644 index 0000000..bd2e3f6 --- /dev/null +++ b/api/AcceptResurrect.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Accepts an offered resurrection spell. Not used for self-resurrection; see UseSoulstone() for such cases. +function AcceptResurrect() end \ No newline at end of file diff --git a/api/AcceptSockets.lua b/api/AcceptSockets.lua new file mode 100644 index 0000000..8a2d675 --- /dev/null +++ b/api/AcceptSockets.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Accepts changes made in the Item Socketing UI. Any gems added are permanently socketed into the item, and any existing gems replaced by new gems are destroyed. This function only has effect while the Item Socketing UI is open (i.e. between the SOCKET_INFO_UPDATE and SOCKET_INFO_CLOSE events). +function AcceptSockets() end \ No newline at end of file diff --git a/api/AcceptSpellConfirmationPrompt.lua b/api/AcceptSpellConfirmationPrompt.lua new file mode 100644 index 0000000..cb1e480 --- /dev/null +++ b/api/AcceptSpellConfirmationPrompt.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function AcceptSpellConfirmationPrompt() end \ No newline at end of file diff --git a/api/AcceptTrade.lua b/api/AcceptTrade.lua new file mode 100644 index 0000000..e401f72 --- /dev/null +++ b/api/AcceptTrade.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Accepts a proposed trade. Once both players have accepted, the trade process completes and the actual exchange of items/money/enchants takes place. +function AcceptTrade() end \ No newline at end of file diff --git a/api/AcceptXPLoss.lua b/api/AcceptXPLoss.lua new file mode 100644 index 0000000..f0bf244 --- /dev/null +++ b/api/AcceptXPLoss.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Resurrects the player at a spirit healer, accepting possible consequences. Resurrecting at a spirit healer generally results in a loss of durability (both equipped items and those in the player's bags) and may also result in the Resurrection Sickness debuff. Early in the development of World of Warcraft, resurrecting at a spirit healer caused a loss of experience points. The change to a loss of item durability was made before the initial public release of World of Warcraft, but the name of this function was never changed. +function AcceptXPLoss() end \ No newline at end of file diff --git a/api/AcknowledgeAutoAcceptQuest.lua b/api/AcknowledgeAutoAcceptQuest.lua new file mode 100644 index 0000000..cc7be34 --- /dev/null +++ b/api/AcknowledgeAutoAcceptQuest.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function AcknowledgeAutoAcceptQuest() end \ No newline at end of file diff --git a/api/AcknowledgeSurvey.lua b/api/AcknowledgeSurvey.lua new file mode 100644 index 0000000..6754faa --- /dev/null +++ b/api/AcknowledgeSurvey.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function AcknowledgeSurvey() end \ No newline at end of file diff --git a/api/ActionHasRange.lua b/api/ActionHasRange.lua new file mode 100644 index 0000000..33ba6db --- /dev/null +++ b/api/ActionHasRange.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return 1nil hasRange +---Returns whether an action has a range restriction +function ActionHasRange(slot) end \ No newline at end of file diff --git a/api/AddAutoQuestPopUp.lua b/api/AddAutoQuestPopUp.lua new file mode 100644 index 0000000..9fecc54 --- /dev/null +++ b/api/AddAutoQuestPopUp.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param questId number +---@param type OFFER +---@param COMPLETE +---@param OFFER +---Create a quest popup in the WatchFrame +function AddAutoQuestPopUp(questId, type, COMPLETE, OFFER) end \ No newline at end of file diff --git a/api/AddChatWindowChannel.lua b/api/AddChatWindowChannel.lua new file mode 100644 index 0000000..34fa67e --- /dev/null +++ b/api/AddChatWindowChannel.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param channel number +---@return number zoneChannel +---Adds a chat channel to the saved list of those displayed in a chat window. Used by the default UI's function ChatFrame_AddChannel() which manages the set of channel messages shown in a displayed ChatFrame. +function AddChatWindowChannel(index, channel) end \ No newline at end of file diff --git a/api/AddChatWindowMessages.lua b/api/AddChatWindowMessages.lua new file mode 100644 index 0000000..e3a0974 --- /dev/null +++ b/api/AddChatWindowMessages.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param messageGroup string +---Adds a message type to the saved list of those displayed in a chat window. Used by the default UI's function ChatFrame_AddMessageGroup(), which manages the set of message types shown in a displayed ChatFrame. +function AddChatWindowMessages(index, messageGroup) end \ No newline at end of file diff --git a/api/AddFriend.lua b/api/AddFriend.lua new file mode 100644 index 0000000..6537f66 --- /dev/null +++ b/api/AddFriend.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---Adds a character to the friends list +function AddFriend(name) end \ No newline at end of file diff --git a/api/AddIgnore.lua b/api/AddIgnore.lua new file mode 100644 index 0000000..7788c72 --- /dev/null +++ b/api/AddIgnore.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---Adds a character to the ignore list +function AddIgnore(name) end \ No newline at end of file diff --git a/api/AddMute.lua b/api/AddMute.lua new file mode 100644 index 0000000..3deb894 --- /dev/null +++ b/api/AddMute.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---Adds a character to the muted list for voice chat. The Muted list acts for voice chat as the Ignore list does for text chat: muted characters will never be heard regardless of which voice channels they join the player in. +function AddMute(name) end \ No newline at end of file diff --git a/api/AddOrDelIgnore.lua b/api/AddOrDelIgnore.lua new file mode 100644 index 0000000..b60f635 --- /dev/null +++ b/api/AddOrDelIgnore.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param fullname string +---Adds the named character to the ignore list, or removes the character if already in the ignore list +function AddOrDelIgnore(fullname) end \ No newline at end of file diff --git a/api/AddOrDelMute.lua b/api/AddOrDelMute.lua new file mode 100644 index 0000000..7383e6f --- /dev/null +++ b/api/AddOrDelMute.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---Adds or removes a character from the voice mute list. Adds the character to the list if he/she is not already on it; removes the character if already on the list. The Muted list acts for voice chat as the Ignore list does for text chat: muted characters will never be heard regardless of which voice channels they join the player in. +function AddOrDelMute(unit, name) end \ No newline at end of file diff --git a/api/AddOrRemoveFriend.lua b/api/AddOrRemoveFriend.lua new file mode 100644 index 0000000..89a33d5 --- /dev/null +++ b/api/AddOrRemoveFriend.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param note string +---Adds the named character to the friends list, or removes the character if already in the friends list +function AddOrRemoveFriend(name, note) end \ No newline at end of file diff --git a/api/AddQuestWatch.lua b/api/AddQuestWatch.lua new file mode 100644 index 0000000..81ba796 --- /dev/null +++ b/api/AddQuestWatch.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param questIndex number +---Adds a quest to the objectives tracker +function AddQuestWatch(questIndex) end \ No newline at end of file diff --git a/api/AddTrackedAchievement.lua b/api/AddTrackedAchievement.lua new file mode 100644 index 0000000..25cc838 --- /dev/null +++ b/api/AddTrackedAchievement.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---Adds an achievement to the objectives tracker UI +function AddTrackedAchievement(id) end \ No newline at end of file diff --git a/api/AddTradeMoney.lua b/api/AddTradeMoney.lua new file mode 100644 index 0000000..89bcc6a --- /dev/null +++ b/api/AddTradeMoney.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Adds the money currently on the cursor to the trade window +function AddTradeMoney() end \ No newline at end of file diff --git a/api/Ambiguate.lua b/api/Ambiguate.lua new file mode 100644 index 0000000..199380a --- /dev/null +++ b/api/Ambiguate.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param fullName string +---@param context string +---@return string name +---Returns a player Name or Name-Realm string suitable for use in a given context. +function Ambiguate(fullName, context) end \ No newline at end of file diff --git a/api/AntiAliasingSupported.lua b/api/AntiAliasingSupported.lua new file mode 100644 index 0000000..efe059c --- /dev/null +++ b/api/AntiAliasingSupported.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function AntiAliasingSupported() end \ No newline at end of file diff --git a/api/ApplyBarberShopStyle.lua b/api/ApplyBarberShopStyle.lua new file mode 100644 index 0000000..5d76591 --- /dev/null +++ b/api/ApplyBarberShopStyle.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Purchases the selected barber shop style changes. Does not exit the barber shop session, so further changes are still allowed. The BARBER_SHOP_SUCCESS and BARBER_SHOP_APPEARANCE_APPLIED events fire once the style change takes effect. +function ApplyBarberShopStyle() end \ No newline at end of file diff --git a/api/ApplyTransmogrifications.lua b/api/ApplyTransmogrifications.lua new file mode 100644 index 0000000..dd056fa --- /dev/null +++ b/api/ApplyTransmogrifications.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Applies all pending transmogrifications, and pays for the cost +function ApplyTransmogrifications() end \ No newline at end of file diff --git a/api/ArchaeologyGetIconInfo.lua b/api/ArchaeologyGetIconInfo.lua new file mode 100644 index 0000000..253bfac --- /dev/null +++ b/api/ArchaeologyGetIconInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ArchaeologyGetIconInfo() end \ No newline at end of file diff --git a/api/ArchaeologyMapUpdateAll.lua b/api/ArchaeologyMapUpdateAll.lua new file mode 100644 index 0000000..7ae09d0 --- /dev/null +++ b/api/ArchaeologyMapUpdateAll.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numEntries +---Returns the number of digsites in the current zone. The value returned reflects dig sites for the current zone: If the world map is visible, the currently viewed zone; else, the player's zone. It will always return 0 when called while the zone is continent or further zoomed out. +function ArchaeologyMapUpdateAll() end \ No newline at end of file diff --git a/api/ArcheologyGetVisibleBlobID.lua b/api/ArcheologyGetVisibleBlobID.lua new file mode 100644 index 0000000..4c535c7 --- /dev/null +++ b/api/ArcheologyGetVisibleBlobID.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number blobID +---Returns the blob ID for an archaeology map landmark. Only works for the Archaeology system. The function's name is misspelled in the WoW API (should be Archaeology to be consistent with the rest of the API). +function ArcheologyGetVisibleBlobID(index) end \ No newline at end of file diff --git a/api/AreAccountAchievementsHidden.lua b/api/AreAccountAchievementsHidden.lua new file mode 100644 index 0000000..d3235eb --- /dev/null +++ b/api/AreAccountAchievementsHidden.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isHidden +---Returns whether the player is displaying only character achievements to others +function AreAccountAchievementsHidden() end \ No newline at end of file diff --git a/api/ArenaTeam_GetTeamSizeID.lua b/api/ArenaTeam_GetTeamSizeID.lua new file mode 100644 index 0000000..1902285 --- /dev/null +++ b/api/ArenaTeam_GetTeamSizeID.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param teamSize number +---@return number teamID +---Converts an arena team size to the appropriate numeric arena team identifier +function ArenaTeam_GetTeamSizeID(teamSize) end \ No newline at end of file diff --git a/api/AscendStop.lua b/api/AscendStop.lua new file mode 100644 index 0000000..93c6de6 --- /dev/null +++ b/api/AscendStop.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Stops movement initiated by JumpOrAscendStart. Used by the JUMP binding, which also controls ascent when swimming or flying. Has no meaningful effect if called while jumping (in which case movement is generally stopped by hitting the ground). +function AscendStop() end \ No newline at end of file diff --git a/api/AssistUnit.lua b/api/AssistUnit.lua new file mode 100644 index 0000000..b7436c3 --- /dev/null +++ b/api/AssistUnit.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---Targets the unit targeted by another unit +function AssistUnit(unit, name) end \ No newline at end of file diff --git a/api/AttackTarget.lua b/api/AttackTarget.lua new file mode 100644 index 0000000..5ac76e4 --- /dev/null +++ b/api/AttackTarget.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Begins auto-attack against the player's current target. (If the "Auto Attack/Auto Shot" option is turned on, also begins Auto Shot for hunters.) +function AttackTarget() end \ No newline at end of file diff --git a/api/AutoChooseCurrentGraphicsSetting.lua b/api/AutoChooseCurrentGraphicsSetting.lua new file mode 100644 index 0000000..512d86a --- /dev/null +++ b/api/AutoChooseCurrentGraphicsSetting.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function AutoChooseCurrentGraphicsSetting() end \ No newline at end of file diff --git a/api/AutoEquipCursorItem.lua b/api/AutoEquipCursorItem.lua new file mode 100644 index 0000000..58a4de7 --- /dev/null +++ b/api/AutoEquipCursorItem.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Equips the item on the cursor. The item is automatically equipped in the first available slot in which it fits. To equip an item in a specific slot, see EquipCursorItem(). Causes an error message (UI_ERROR_MESSAGE) if the item on the cursor cannot be equipped. Does nothing if the cursor does not contain an item. +function AutoEquipCursorItem() end \ No newline at end of file diff --git a/api/AutoLootMailItem.lua b/api/AutoLootMailItem.lua new file mode 100644 index 0000000..23be214 --- /dev/null +++ b/api/AutoLootMailItem.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param mailID number +---Automatically takes any attached items and money from a mail. If the mail does not have body text (which can be saved as a permanent copy), also deletes the mail. +function AutoLootMailItem(mailID) end \ No newline at end of file diff --git a/api/AutoStoreGuildBankItem.lua b/api/AutoStoreGuildBankItem.lua new file mode 100644 index 0000000..ec9e409 --- /dev/null +++ b/api/AutoStoreGuildBankItem.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param tab number +---@param slot number +---Withdraws the item(s) from a slot in the guild bank, automatically adding to the player's bags +function AutoStoreGuildBankItem(tab, slot) end \ No newline at end of file diff --git a/api/BNAcceptFriendInvite.lua b/api/BNAcceptFriendInvite.lua new file mode 100644 index 0000000..5623ec9 --- /dev/null +++ b/api/BNAcceptFriendInvite.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNAcceptFriendInvite() end \ No newline at end of file diff --git a/api/BNCheckBattleTagInviteToGuildMember.lua b/api/BNCheckBattleTagInviteToGuildMember.lua new file mode 100644 index 0000000..b8445a6 --- /dev/null +++ b/api/BNCheckBattleTagInviteToGuildMember.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNCheckBattleTagInviteToGuildMember() end \ No newline at end of file diff --git a/api/BNCheckBattleTagInviteToUnit.lua b/api/BNCheckBattleTagInviteToUnit.lua new file mode 100644 index 0000000..cb7d436 --- /dev/null +++ b/api/BNCheckBattleTagInviteToUnit.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNCheckBattleTagInviteToUnit() end \ No newline at end of file diff --git a/api/BNConnected.lua b/api/BNConnected.lua new file mode 100644 index 0000000..af2ea2c --- /dev/null +++ b/api/BNConnected.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean isOnline +---Returns whether or not the player is connected to Battle.net +function BNConnected() end \ No newline at end of file diff --git a/api/BNCreateConversation.lua b/api/BNCreateConversation.lua new file mode 100644 index 0000000..230b00f --- /dev/null +++ b/api/BNCreateConversation.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param presenceID_1 number +---@param presenceID_2 number +---@return boolean result +---Create a conversation between you and two friends +function BNCreateConversation(presenceID_1, presenceID_2) end \ No newline at end of file diff --git a/api/BNDeclineFriendInvite.lua b/api/BNDeclineFriendInvite.lua new file mode 100644 index 0000000..61ac369 --- /dev/null +++ b/api/BNDeclineFriendInvite.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNDeclineFriendInvite() end \ No newline at end of file diff --git a/api/BNFeaturesEnabled.lua b/api/BNFeaturesEnabled.lua new file mode 100644 index 0000000..87f8945 --- /dev/null +++ b/api/BNFeaturesEnabled.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean isEnabled +---Returns whether or not RealID services are disabled +function BNFeaturesEnabled() end \ No newline at end of file diff --git a/api/BNFeaturesEnabledAndConnected.lua b/api/BNFeaturesEnabledAndConnected.lua new file mode 100644 index 0000000..48d18c6 --- /dev/null +++ b/api/BNFeaturesEnabledAndConnected.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNFeaturesEnabledAndConnected() end \ No newline at end of file diff --git a/api/BNGetBlockedInfo.lua b/api/BNGetBlockedInfo.lua new file mode 100644 index 0000000..768044f --- /dev/null +++ b/api/BNGetBlockedInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNGetBlockedInfo() end \ No newline at end of file diff --git a/api/BNGetBlockedToonInfo.lua b/api/BNGetBlockedToonInfo.lua new file mode 100644 index 0000000..c538ca8 --- /dev/null +++ b/api/BNGetBlockedToonInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNGetBlockedToonInfo() end \ No newline at end of file diff --git a/api/BNGetConversationInfo.lua b/api/BNGetConversationInfo.lua new file mode 100644 index 0000000..69b8975 --- /dev/null +++ b/api/BNGetConversationInfo.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param channel number +---@return string type +---Returns information about an existing battle.net conversation +function BNGetConversationInfo(channel) end \ No newline at end of file diff --git a/api/BNGetConversationMemberInfo.lua b/api/BNGetConversationMemberInfo.lua new file mode 100644 index 0000000..7041b4e --- /dev/null +++ b/api/BNGetConversationMemberInfo.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param channel number +---@param memberIndex number +---@return number presenceID +---@return number unknown +---@return string displayName +---Returns information about a member of a battle.net conversation +function BNGetConversationMemberInfo(channel, memberIndex) end \ No newline at end of file diff --git a/api/BNGetCustomMessageTable.lua b/api/BNGetCustomMessageTable.lua new file mode 100644 index 0000000..56ef21f --- /dev/null +++ b/api/BNGetCustomMessageTable.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNGetCustomMessageTable() end \ No newline at end of file diff --git a/api/BNGetFOFInfo.lua b/api/BNGetFOFInfo.lua new file mode 100644 index 0000000..ccd41ae --- /dev/null +++ b/api/BNGetFOFInfo.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param presenceID number +---@param mutual boolean +---@param non-mutual boolean +---@param index number +---@return number presenceID +---@return string givenName +---@return string surname +---@return boolean isFriend +---Returns information about the specified friend of a RealID friend +function BNGetFOFInfo(presenceID, mutual, non-mutual, index) end \ No newline at end of file diff --git a/api/BNGetFriendIndex.lua b/api/BNGetFriendIndex.lua new file mode 100644 index 0000000..0a33617 --- /dev/null +++ b/api/BNGetFriendIndex.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param presenceID number +---@return number index +---Returns friendlist index of a BN friend +function BNGetFriendIndex(presenceID) end \ No newline at end of file diff --git a/api/BNGetFriendInfo.lua b/api/BNGetFriendInfo.lua new file mode 100644 index 0000000..1c5fa63 --- /dev/null +++ b/api/BNGetFriendInfo.lua @@ -0,0 +1,21 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param friendIndex number +---@return number presenceID +---@return string presenceName +---@return string battleTag +---@return boolean isBattleTagPresence +---@return string toonName +---@return number toonID +---@return string client +---@return boolean isOnline +---@return number lastOnline +---@return boolean isAFK +---@return boolean isDND +---@return string messageText +---@return string noteText +---@return boolean isRIDFriend +---@return number broadcastTime +---@return boolean canSoR +---Returns information about a RealID friend by index +function BNGetFriendInfo(friendIndex) end \ No newline at end of file diff --git a/api/BNGetFriendInfoByID.lua b/api/BNGetFriendInfoByID.lua new file mode 100644 index 0000000..6ee8f93 --- /dev/null +++ b/api/BNGetFriendInfoByID.lua @@ -0,0 +1,21 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param presenceID number +---@return number presenceID +---@return |K string presenceName +---@return |K string battleTag +---@return boolean isBattleTagPresence +---@return string toonName +---@return number toonID +---@return string client +---@return boolean isOnline +---@return number lastOnline +---@return boolean isAFK +---@return boolean isDND +---@return string messageText +---@return string noteText +---@return boolean isRIDFriend +---@return number broadcastTime +---@return boolean canSoR +---Returns information about a RealID friend +function BNGetFriendInfoByID(presenceID) end \ No newline at end of file diff --git a/api/BNGetFriendInviteInfo.lua b/api/BNGetFriendInviteInfo.lua new file mode 100644 index 0000000..4a72bf3 --- /dev/null +++ b/api/BNGetFriendInviteInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNGetFriendInviteInfo() end \ No newline at end of file diff --git a/api/BNGetFriendToonInfo.lua b/api/BNGetFriendToonInfo.lua new file mode 100644 index 0000000..70ee8c1 --- /dev/null +++ b/api/BNGetFriendToonInfo.lua @@ -0,0 +1,20 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param friendIndex number +---@param toonIndex number +---@return boolean hasFocus +---@return string toonName +---@return string client +---@return string realmName +---@return number realmId +---@return number faction +---@return string race +---@return string class +---@return string unknown +---@return string zoneName +---@return string level +---@return string gameText +---@return string broadcastText +---@return string broadcastTime +---Returns information about a particular online toon tied to a RealID friend +function BNGetFriendToonInfo(friendIndex, toonIndex) end \ No newline at end of file diff --git a/api/BNGetInfo.lua b/api/BNGetInfo.lua new file mode 100644 index 0000000..607f177 --- /dev/null +++ b/api/BNGetInfo.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number unknownPresenceID1 +---@return string battleTag +---@return number unknownPresenceID2 +---@return string broadcastText +---@return boolean bnetAFK +---@return boolean bnetDND +---@return boolean unknown +---Returns information about the player's RealID settings +function BNGetInfo() end \ No newline at end of file diff --git a/api/BNGetMatureLanguageFilter.lua b/api/BNGetMatureLanguageFilter.lua new file mode 100644 index 0000000..8644b4f --- /dev/null +++ b/api/BNGetMatureLanguageFilter.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean isEnabled +---Returns boolean for the Mature Language Filter option's state. +function BNGetMatureLanguageFilter() end \ No newline at end of file diff --git a/api/BNGetMaxNumConversations.lua b/api/BNGetMaxNumConversations.lua new file mode 100644 index 0000000..9a359d1 --- /dev/null +++ b/api/BNGetMaxNumConversations.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number count +---Returns the maximum number of simultaneous RealID conversations you can be a part of +function BNGetMaxNumConversations() end \ No newline at end of file diff --git a/api/BNGetMaxPlayersInConversation.lua b/api/BNGetMaxPlayersInConversation.lua new file mode 100644 index 0000000..6901f6c --- /dev/null +++ b/api/BNGetMaxPlayersInConversation.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number count +---Returns the maximum number of realID friends you can have in one conversation +function BNGetMaxPlayersInConversation() end \ No newline at end of file diff --git a/api/BNGetNumBlocked.lua b/api/BNGetNumBlocked.lua new file mode 100644 index 0000000..50a3702 --- /dev/null +++ b/api/BNGetNumBlocked.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNGetNumBlocked() end \ No newline at end of file diff --git a/api/BNGetNumBlockedToons.lua b/api/BNGetNumBlockedToons.lua new file mode 100644 index 0000000..57c62e2 --- /dev/null +++ b/api/BNGetNumBlockedToons.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNGetNumBlockedToons() end \ No newline at end of file diff --git a/api/BNGetNumConversationMembers.lua b/api/BNGetNumConversationMembers.lua new file mode 100644 index 0000000..e96c0fa --- /dev/null +++ b/api/BNGetNumConversationMembers.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param channel number +---@return number memberCount +---Returns the number of members in a battle.net conversation +function BNGetNumConversationMembers(channel) end \ No newline at end of file diff --git a/api/BNGetNumFOF.lua b/api/BNGetNumFOF.lua new file mode 100644 index 0000000..0ff7193 --- /dev/null +++ b/api/BNGetNumFOF.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNGetNumFOF() end \ No newline at end of file diff --git a/api/BNGetNumFriendInvites.lua b/api/BNGetNumFriendInvites.lua new file mode 100644 index 0000000..a64623d --- /dev/null +++ b/api/BNGetNumFriendInvites.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNGetNumFriendInvites() end \ No newline at end of file diff --git a/api/BNGetNumFriendToons.lua b/api/BNGetNumFriendToons.lua new file mode 100644 index 0000000..d859e9c --- /dev/null +++ b/api/BNGetNumFriendToons.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param friendIndex number +---@return number numToons +---Returns the number of online toons for a friend +function BNGetNumFriendToons(friendIndex) end \ No newline at end of file diff --git a/api/BNGetNumFriends.lua b/api/BNGetNumFriends.lua new file mode 100644 index 0000000..22c827d --- /dev/null +++ b/api/BNGetNumFriends.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number totalBNet +---@return number numBNetOnline +---Returns total number of RealID friends and currently online number of RealID friends +function BNGetNumFriends() end \ No newline at end of file diff --git a/api/BNGetSelectedBlock.lua b/api/BNGetSelectedBlock.lua new file mode 100644 index 0000000..4975b9c --- /dev/null +++ b/api/BNGetSelectedBlock.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNGetSelectedBlock() end \ No newline at end of file diff --git a/api/BNGetSelectedFriend.lua b/api/BNGetSelectedFriend.lua new file mode 100644 index 0000000..b4a950f --- /dev/null +++ b/api/BNGetSelectedFriend.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number friendIndex +---Returns the index of the selected user on your friend's list +function BNGetSelectedFriend() end \ No newline at end of file diff --git a/api/BNGetSelectedToonBlock.lua b/api/BNGetSelectedToonBlock.lua new file mode 100644 index 0000000..5c8ac4b --- /dev/null +++ b/api/BNGetSelectedToonBlock.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNGetSelectedToonBlock() end \ No newline at end of file diff --git a/api/BNGetToonInfo.lua b/api/BNGetToonInfo.lua new file mode 100644 index 0000000..1f20fac --- /dev/null +++ b/api/BNGetToonInfo.lua @@ -0,0 +1,21 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param bnetIDGameAccount number +---@return boolean unknown +---@return string toonName +---@return string client +---@return string realmName +---@return number realmID +---@return string faction +---@return string race +---@return string class +---@return string unknown +---@return string zoneName +---@return string level +---@return string gameText +---@return string broadcastText +---@return string broadcastTime +---@return boolean unknown +---@return string presenceID +---Returns information about the active game account tied to a Real ID friend. Returns nil if the player is not online. +function BNGetToonInfo(bnetIDGameAccount) end \ No newline at end of file diff --git a/api/BNInviteFriend.lua b/api/BNInviteFriend.lua new file mode 100644 index 0000000..b626a08 --- /dev/null +++ b/api/BNInviteFriend.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNInviteFriend() end \ No newline at end of file diff --git a/api/BNInviteToConversation.lua b/api/BNInviteToConversation.lua new file mode 100644 index 0000000..1b3aa50 --- /dev/null +++ b/api/BNInviteToConversation.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param channel number +---@param presenceID number +---Invite a friend into an existing conversation +function BNInviteToConversation(channel, presenceID) end \ No newline at end of file diff --git a/api/BNIsBlocked.lua b/api/BNIsBlocked.lua new file mode 100644 index 0000000..0f9524d --- /dev/null +++ b/api/BNIsBlocked.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNIsBlocked() end \ No newline at end of file diff --git a/api/BNIsFriend.lua b/api/BNIsFriend.lua new file mode 100644 index 0000000..93306d8 --- /dev/null +++ b/api/BNIsFriend.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNIsFriend() end \ No newline at end of file diff --git a/api/BNIsFriendConversationValid.lua b/api/BNIsFriendConversationValid.lua new file mode 100644 index 0000000..7f3546e --- /dev/null +++ b/api/BNIsFriendConversationValid.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNIsFriendConversationValid() end \ No newline at end of file diff --git a/api/BNIsSelf.lua b/api/BNIsSelf.lua new file mode 100644 index 0000000..fbc6427 --- /dev/null +++ b/api/BNIsSelf.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param presenceID number +---@return boolean isSelf +---Returns whether or not the presence ID is the one of the player +function BNIsSelf(presenceID) end \ No newline at end of file diff --git a/api/BNIsToonBlocked.lua b/api/BNIsToonBlocked.lua new file mode 100644 index 0000000..a8b906a --- /dev/null +++ b/api/BNIsToonBlocked.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNIsToonBlocked() end \ No newline at end of file diff --git a/api/BNLeaveConversation.lua b/api/BNLeaveConversation.lua new file mode 100644 index 0000000..f7ac3ef --- /dev/null +++ b/api/BNLeaveConversation.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNLeaveConversation() end \ No newline at end of file diff --git a/api/BNListConversation.lua b/api/BNListConversation.lua new file mode 100644 index 0000000..19f853c --- /dev/null +++ b/api/BNListConversation.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNListConversation() end \ No newline at end of file diff --git a/api/BNRemoveFriend.lua b/api/BNRemoveFriend.lua new file mode 100644 index 0000000..b4fd195 --- /dev/null +++ b/api/BNRemoveFriend.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNRemoveFriend() end \ No newline at end of file diff --git a/api/BNReportFriendInvite.lua b/api/BNReportFriendInvite.lua new file mode 100644 index 0000000..d833c1a --- /dev/null +++ b/api/BNReportFriendInvite.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNReportFriendInvite() end \ No newline at end of file diff --git a/api/BNReportPlayer.lua b/api/BNReportPlayer.lua new file mode 100644 index 0000000..7c4fd47 --- /dev/null +++ b/api/BNReportPlayer.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNReportPlayer() end \ No newline at end of file diff --git a/api/BNRequestFOFInfo.lua b/api/BNRequestFOFInfo.lua new file mode 100644 index 0000000..fb79f81 --- /dev/null +++ b/api/BNRequestFOFInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNRequestFOFInfo() end \ No newline at end of file diff --git a/api/BNSendConversationMessage.lua b/api/BNSendConversationMessage.lua new file mode 100644 index 0000000..3a7f655 --- /dev/null +++ b/api/BNSendConversationMessage.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNSendConversationMessage() end \ No newline at end of file diff --git a/api/BNSendFriendInvite.lua b/api/BNSendFriendInvite.lua new file mode 100644 index 0000000..43d4753 --- /dev/null +++ b/api/BNSendFriendInvite.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNSendFriendInvite() end \ No newline at end of file diff --git a/api/BNSendFriendInviteByID.lua b/api/BNSendFriendInviteByID.lua new file mode 100644 index 0000000..48f18ce --- /dev/null +++ b/api/BNSendFriendInviteByID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNSendFriendInviteByID() end \ No newline at end of file diff --git a/api/BNSendGameData.lua b/api/BNSendGameData.lua new file mode 100644 index 0000000..71a614c --- /dev/null +++ b/api/BNSendGameData.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param presenceID number +---@param addonPrefix string +---@param message string +---Sends some data to another player +function BNSendGameData(presenceID, addonPrefix, message) end \ No newline at end of file diff --git a/api/BNSendSoR.lua b/api/BNSendSoR.lua new file mode 100644 index 0000000..0b2d0ff --- /dev/null +++ b/api/BNSendSoR.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNSendSoR() end \ No newline at end of file diff --git a/api/BNSendVerifiedBattleTagInvite.lua b/api/BNSendVerifiedBattleTagInvite.lua new file mode 100644 index 0000000..b1bb41d --- /dev/null +++ b/api/BNSendVerifiedBattleTagInvite.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNSendVerifiedBattleTagInvite() end \ No newline at end of file diff --git a/api/BNSendWhisper.lua b/api/BNSendWhisper.lua new file mode 100644 index 0000000..9e6977a --- /dev/null +++ b/api/BNSendWhisper.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param presenceID number +---@param messageText text +---Sends a whisper over Battle.Net +function BNSendWhisper(presenceID, messageText) end \ No newline at end of file diff --git a/api/BNSetAFK.lua b/api/BNSetAFK.lua new file mode 100644 index 0000000..cf760ea --- /dev/null +++ b/api/BNSetAFK.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNSetAFK() end \ No newline at end of file diff --git a/api/BNSetBlocked.lua b/api/BNSetBlocked.lua new file mode 100644 index 0000000..287ecb7 --- /dev/null +++ b/api/BNSetBlocked.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNSetBlocked() end \ No newline at end of file diff --git a/api/BNSetCustomMessage.lua b/api/BNSetCustomMessage.lua new file mode 100644 index 0000000..8c87c67 --- /dev/null +++ b/api/BNSetCustomMessage.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param broadcastText string +---Sets the player's current RealID broadcast message. +function BNSetCustomMessage(broadcastText) end \ No newline at end of file diff --git a/api/BNSetDND.lua b/api/BNSetDND.lua new file mode 100644 index 0000000..764aa3e --- /dev/null +++ b/api/BNSetDND.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNSetDND() end \ No newline at end of file diff --git a/api/BNSetFocus.lua b/api/BNSetFocus.lua new file mode 100644 index 0000000..c217902 --- /dev/null +++ b/api/BNSetFocus.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNSetFocus() end \ No newline at end of file diff --git a/api/BNSetFriendNote.lua b/api/BNSetFriendNote.lua new file mode 100644 index 0000000..5fe064a --- /dev/null +++ b/api/BNSetFriendNote.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param presenceID number +---@param note string +---Changes the private note for a RealID friend +function BNSetFriendNote(presenceID, note) end \ No newline at end of file diff --git a/api/BNSetMatureLanguageFilter.lua b/api/BNSetMatureLanguageFilter.lua new file mode 100644 index 0000000..a421d88 --- /dev/null +++ b/api/BNSetMatureLanguageFilter.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param enabled boolean +---Sets the Mature Language Filter option +function BNSetMatureLanguageFilter(enabled) end \ No newline at end of file diff --git a/api/BNSetSelectedBlock.lua b/api/BNSetSelectedBlock.lua new file mode 100644 index 0000000..259d91d --- /dev/null +++ b/api/BNSetSelectedBlock.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNSetSelectedBlock() end \ No newline at end of file diff --git a/api/BNSetSelectedFriend.lua b/api/BNSetSelectedFriend.lua new file mode 100644 index 0000000..40810f7 --- /dev/null +++ b/api/BNSetSelectedFriend.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNSetSelectedFriend() end \ No newline at end of file diff --git a/api/BNSetSelectedToonBlock.lua b/api/BNSetSelectedToonBlock.lua new file mode 100644 index 0000000..ce27459 --- /dev/null +++ b/api/BNSetSelectedToonBlock.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNSetSelectedToonBlock() end \ No newline at end of file diff --git a/api/BNSetToonBlocked.lua b/api/BNSetToonBlocked.lua new file mode 100644 index 0000000..57ef788 --- /dev/null +++ b/api/BNSetToonBlocked.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNSetToonBlocked() end \ No newline at end of file diff --git a/api/BNSummonFriendByIndex.lua b/api/BNSummonFriendByIndex.lua new file mode 100644 index 0000000..0a577ec --- /dev/null +++ b/api/BNSummonFriendByIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNSummonFriendByIndex() end \ No newline at end of file diff --git a/api/BNTokenFindName.lua b/api/BNTokenFindName.lua new file mode 100644 index 0000000..39891ca --- /dev/null +++ b/api/BNTokenFindName.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BNTokenFindName() end \ No newline at end of file diff --git a/api/BankButtonIDToInvSlotID.lua b/api/BankButtonIDToInvSlotID.lua new file mode 100644 index 0000000..4e8210c --- /dev/null +++ b/api/BankButtonIDToInvSlotID.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param buttonID number +---@param isBag 1nil +---@return number inventoryID +---Returns the inventoryID corresponding to a bank item or bag slot. The results of this function can be used with GetInventorySlotInfo() and other related inventory functions. +function BankButtonIDToInvSlotID(buttonID, isBag) end \ No newline at end of file diff --git a/api/BarberShopReset.lua b/api/BarberShopReset.lua new file mode 100644 index 0000000..196720e --- /dev/null +++ b/api/BarberShopReset.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Resets barber shop options to the currently worn styles. Changes the underlying data (and thus the character's appearance) only; the default barbershop UI does not update. +function BarberShopReset() end \ No newline at end of file diff --git a/api/BattlefieldMgrEntryInviteResponse.lua b/api/BattlefieldMgrEntryInviteResponse.lua new file mode 100644 index 0000000..2485b01 --- /dev/null +++ b/api/BattlefieldMgrEntryInviteResponse.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BattlefieldMgrEntryInviteResponse() end \ No newline at end of file diff --git a/api/BattlefieldMgrExitRequest.lua b/api/BattlefieldMgrExitRequest.lua new file mode 100644 index 0000000..f7f7693 --- /dev/null +++ b/api/BattlefieldMgrExitRequest.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BattlefieldMgrExitRequest() end \ No newline at end of file diff --git a/api/BattlefieldMgrQueueInviteResponse.lua b/api/BattlefieldMgrQueueInviteResponse.lua new file mode 100644 index 0000000..a85dfa2 --- /dev/null +++ b/api/BattlefieldMgrQueueInviteResponse.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BattlefieldMgrQueueInviteResponse() end \ No newline at end of file diff --git a/api/BattlefieldMgrQueueRequest.lua b/api/BattlefieldMgrQueueRequest.lua new file mode 100644 index 0000000..a9b5066 --- /dev/null +++ b/api/BattlefieldMgrQueueRequest.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BattlefieldMgrQueueRequest() end \ No newline at end of file diff --git a/api/BeginTrade.lua b/api/BeginTrade.lua new file mode 100644 index 0000000..e118392 --- /dev/null +++ b/api/BeginTrade.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BeginTrade() end \ No newline at end of file diff --git a/api/BindEnchant.lua b/api/BindEnchant.lua new file mode 100644 index 0000000..f058064 --- /dev/null +++ b/api/BindEnchant.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Confirms enchanting an item (when the item will become soulbound as a result). Usable following the BIND_ENCHANT event which fires upon attempting to perform an enchantment that would cause the target item to become soulbound. +function BindEnchant() end \ No newline at end of file diff --git a/api/BreakUpLargeNumbers.lua b/api/BreakUpLargeNumbers.lua new file mode 100644 index 0000000..3a50d9c --- /dev/null +++ b/api/BreakUpLargeNumbers.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BreakUpLargeNumbers() end \ No newline at end of file diff --git a/api/BuyGuildBankTab.lua b/api/BuyGuildBankTab.lua new file mode 100644 index 0000000..ab5d8a2 --- /dev/null +++ b/api/BuyGuildBankTab.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Purchases the next available guild bank tab +function BuyGuildBankTab() end \ No newline at end of file diff --git a/api/BuyGuildCharter.lua b/api/BuyGuildCharter.lua new file mode 100644 index 0000000..e8c1d63 --- /dev/null +++ b/api/BuyGuildCharter.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param guildName string +---Purchases a guild charter. Usable if the player is interacting with a guild registrar (i.e. between the GUILD_REGISTRAR_SHOW and GUILD_REGISTRAR_CLOSED events). +function BuyGuildCharter(guildName) end \ No newline at end of file diff --git a/api/BuyMerchantItem.lua b/api/BuyMerchantItem.lua new file mode 100644 index 0000000..7d0ffe3 --- /dev/null +++ b/api/BuyMerchantItem.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param quantity number +---Purchases an item available from a vendor +function BuyMerchantItem(index, quantity) end \ No newline at end of file diff --git a/api/BuyReagentBank.lua b/api/BuyReagentBank.lua new file mode 100644 index 0000000..fc94a2f --- /dev/null +++ b/api/BuyReagentBank.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function BuyReagentBank() end \ No newline at end of file diff --git a/api/BuyTrainerService.lua b/api/BuyTrainerService.lua new file mode 100644 index 0000000..d605353 --- /dev/null +++ b/api/BuyTrainerService.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Purchases an ability or recipe available from a trainer +function BuyTrainerService(index) end \ No newline at end of file diff --git a/api/BuybackItem.lua b/api/BuybackItem.lua new file mode 100644 index 0000000..5e8ed97 --- /dev/null +++ b/api/BuybackItem.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Repurchases an item recently sold to a vendor +function BuybackItem(index) end \ No newline at end of file diff --git a/api/C_BlackMarket.Close.lua b/api/C_BlackMarket.Close.lua new file mode 100644 index 0000000..601054b --- /dev/null +++ b/api/C_BlackMarket.Close.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_BlackMarket.Close() end \ No newline at end of file diff --git a/api/C_BlackMarket.GetHotItem.lua b/api/C_BlackMarket.GetHotItem.lua new file mode 100644 index 0000000..cc67568 --- /dev/null +++ b/api/C_BlackMarket.GetHotItem.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_BlackMarket.GetHotItem() end \ No newline at end of file diff --git a/api/C_BlackMarket.GetItemInfoByID.lua b/api/C_BlackMarket.GetItemInfoByID.lua new file mode 100644 index 0000000..8cd615e --- /dev/null +++ b/api/C_BlackMarket.GetItemInfoByID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_BlackMarket.GetItemInfoByID() end \ No newline at end of file diff --git a/api/C_BlackMarket.GetItemInfoByIndex.lua b/api/C_BlackMarket.GetItemInfoByIndex.lua new file mode 100644 index 0000000..2c4f715 --- /dev/null +++ b/api/C_BlackMarket.GetItemInfoByIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_BlackMarket.GetItemInfoByIndex() end \ No newline at end of file diff --git a/api/C_BlackMarket.GetNumItems.lua b/api/C_BlackMarket.GetNumItems.lua new file mode 100644 index 0000000..9b5bca3 --- /dev/null +++ b/api/C_BlackMarket.GetNumItems.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_BlackMarket.GetNumItems() end \ No newline at end of file diff --git a/api/C_BlackMarket.ItemPlaceBid.lua b/api/C_BlackMarket.ItemPlaceBid.lua new file mode 100644 index 0000000..b84ef4b --- /dev/null +++ b/api/C_BlackMarket.ItemPlaceBid.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_BlackMarket.ItemPlaceBid() end \ No newline at end of file diff --git a/api/C_BlackMarket.RequestItems.lua b/api/C_BlackMarket.RequestItems.lua new file mode 100644 index 0000000..0bd44c0 --- /dev/null +++ b/api/C_BlackMarket.RequestItems.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Requests updated black market auction information from the server.. The black market UI must be open according to the server in order for this function to have any effect. +function C_BlackMarket.RequestItems() end \ No newline at end of file diff --git a/api/C_Garrison.AddFollowerToMission.lua b/api/C_Garrison.AddFollowerToMission.lua new file mode 100644 index 0000000..e5a88f4 --- /dev/null +++ b/api/C_Garrison.AddFollowerToMission.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.AddFollowerToMission() end \ No newline at end of file diff --git a/api/C_Garrison.AssignFollowerToBuilding.lua b/api/C_Garrison.AssignFollowerToBuilding.lua new file mode 100644 index 0000000..e652616 --- /dev/null +++ b/api/C_Garrison.AssignFollowerToBuilding.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.AssignFollowerToBuilding() end \ No newline at end of file diff --git a/api/C_Garrison.CanGenerateRecruits.lua b/api/C_Garrison.CanGenerateRecruits.lua new file mode 100644 index 0000000..7bd1091 --- /dev/null +++ b/api/C_Garrison.CanGenerateRecruits.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.CanGenerateRecruits() end \ No newline at end of file diff --git a/api/C_Garrison.CanOpenMissionChest.lua b/api/C_Garrison.CanOpenMissionChest.lua new file mode 100644 index 0000000..02f7c5b --- /dev/null +++ b/api/C_Garrison.CanOpenMissionChest.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.CanOpenMissionChest() end \ No newline at end of file diff --git a/api/C_Garrison.CanSetRecruitmentPreference.lua b/api/C_Garrison.CanSetRecruitmentPreference.lua new file mode 100644 index 0000000..9af8019 --- /dev/null +++ b/api/C_Garrison.CanSetRecruitmentPreference.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.CanSetRecruitmentPreference() end \ No newline at end of file diff --git a/api/C_Garrison.CanUpgradeGarrison.lua b/api/C_Garrison.CanUpgradeGarrison.lua new file mode 100644 index 0000000..1c06373 --- /dev/null +++ b/api/C_Garrison.CanUpgradeGarrison.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.CanUpgradeGarrison() end \ No newline at end of file diff --git a/api/C_Garrison.CancelConstruction.lua b/api/C_Garrison.CancelConstruction.lua new file mode 100644 index 0000000..dfb4f17 --- /dev/null +++ b/api/C_Garrison.CancelConstruction.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.CancelConstruction() end \ No newline at end of file diff --git a/api/C_Garrison.CastSpellOnFollower.lua b/api/C_Garrison.CastSpellOnFollower.lua new file mode 100644 index 0000000..00960a1 --- /dev/null +++ b/api/C_Garrison.CastSpellOnFollower.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.CastSpellOnFollower() end \ No newline at end of file diff --git a/api/C_Garrison.CloseArchitect.lua b/api/C_Garrison.CloseArchitect.lua new file mode 100644 index 0000000..b2f68b3 --- /dev/null +++ b/api/C_Garrison.CloseArchitect.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.CloseArchitect() end \ No newline at end of file diff --git a/api/C_Garrison.CloseGarrisonTradeskillNPC.lua b/api/C_Garrison.CloseGarrisonTradeskillNPC.lua new file mode 100644 index 0000000..0804384 --- /dev/null +++ b/api/C_Garrison.CloseGarrisonTradeskillNPC.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.CloseGarrisonTradeskillNPC() end \ No newline at end of file diff --git a/api/C_Garrison.CloseMissionNPC.lua b/api/C_Garrison.CloseMissionNPC.lua new file mode 100644 index 0000000..2f6c05c --- /dev/null +++ b/api/C_Garrison.CloseMissionNPC.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.CloseMissionNPC() end \ No newline at end of file diff --git a/api/C_Garrison.CloseRecruitmentNPC.lua b/api/C_Garrison.CloseRecruitmentNPC.lua new file mode 100644 index 0000000..c43cbe1 --- /dev/null +++ b/api/C_Garrison.CloseRecruitmentNPC.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.CloseRecruitmentNPC() end \ No newline at end of file diff --git a/api/C_Garrison.CloseTradeskillCrafter.lua b/api/C_Garrison.CloseTradeskillCrafter.lua new file mode 100644 index 0000000..8752749 --- /dev/null +++ b/api/C_Garrison.CloseTradeskillCrafter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.CloseTradeskillCrafter() end \ No newline at end of file diff --git a/api/C_Garrison.GenerateRecruits.lua b/api/C_Garrison.GenerateRecruits.lua new file mode 100644 index 0000000..a76e498 --- /dev/null +++ b/api/C_Garrison.GenerateRecruits.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GenerateRecruits() end \ No newline at end of file diff --git a/api/C_Garrison.GetAvailableMissions.lua b/api/C_Garrison.GetAvailableMissions.lua new file mode 100644 index 0000000..616975e --- /dev/null +++ b/api/C_Garrison.GetAvailableMissions.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Returns an array of available missions.. Returns an array of available missions each with the following structure: description: A short description of the mission cost: The cost in resources of the mission duration: The display duration of the mission (45 min) durationSeconds: The duration of the mission in seconds level: The mission level type: The display mission type (Combat) locPrefix: The mission location with prefix (GarrMissionLocation-FrostfireRidge) rewards: A table of the rewards indexed by the reward ID title: Type of reward (currency or xp) quantity: Amount for the reward (item or currency) icon: Display icon for reward (currency or xp) currencyID: ID of currency type (currency only) itemID: ID of item (items only) followerXP: amount of xp (follower xp only) tooltip: string for display in tooltip (xp only) name: display string for reward (xp only) numRewards: Number of rewards for the mission numFollowers: Number of followers the mission may have state: The state of the mission iLevel: The required iLevel for the mission name: The display name for the mission followers: Table of followers assigned to the mission location: The display location for the mission(Frostfire Ridge) isRare: Whether the mission is of rare quality typeAtlas: Prefixed mission type (GarrMission_MissionIcon-Combat) missionID: The ID of the mission that is used for other API calls. +function C_Garrison.GetAvailableMissions() end \ No newline at end of file diff --git a/api/C_Garrison.GetAvailableRecruits.lua b/api/C_Garrison.GetAvailableRecruits.lua new file mode 100644 index 0000000..59f97cc --- /dev/null +++ b/api/C_Garrison.GetAvailableRecruits.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetAvailableRecruits() end \ No newline at end of file diff --git a/api/C_Garrison.GetBasicMissionInfo.lua b/api/C_Garrison.GetBasicMissionInfo.lua new file mode 100644 index 0000000..79b5a04 --- /dev/null +++ b/api/C_Garrison.GetBasicMissionInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetBasicMissionInfo() end \ No newline at end of file diff --git a/api/C_Garrison.GetBuffedFollowersForMission.lua b/api/C_Garrison.GetBuffedFollowersForMission.lua new file mode 100644 index 0000000..5f37034 --- /dev/null +++ b/api/C_Garrison.GetBuffedFollowersForMission.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetBuffedFollowersForMission() end \ No newline at end of file diff --git a/api/C_Garrison.GetBuildingInfo.lua b/api/C_Garrison.GetBuildingInfo.lua new file mode 100644 index 0000000..d13dfac --- /dev/null +++ b/api/C_Garrison.GetBuildingInfo.lua @@ -0,0 +1,22 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param buildingID number +---@return number buildingID +---@return string buildingName +---@return string texturePrefix +---@return string icon +---@return string description +---@return number rank +---@return number currencyID +---@return number currencyAmount +---@return number goldAmount +---@return string timeRequirement +---@return boolean needsPlan +---@return boolean isPreBuilt +---@return table possSpecs +---@return table upgrades +---@return boolean canUpgrade +---@return boolean isMaxLevel +---@return boolean hasFollowerSlot +---Returns information on a garrison building. For additional information on the character's buildings, check out C_Garrison.GetOwnedBuildingInfo() +function C_Garrison.GetBuildingInfo(buildingID) end \ No newline at end of file diff --git a/api/C_Garrison.GetBuildingLockInfo.lua b/api/C_Garrison.GetBuildingLockInfo.lua new file mode 100644 index 0000000..4d84fc9 --- /dev/null +++ b/api/C_Garrison.GetBuildingLockInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetBuildingLockInfo() end \ No newline at end of file diff --git a/api/C_Garrison.GetBuildingSizes.lua b/api/C_Garrison.GetBuildingSizes.lua new file mode 100644 index 0000000..b8a6602 --- /dev/null +++ b/api/C_Garrison.GetBuildingSizes.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetBuildingSizes() end \ No newline at end of file diff --git a/api/C_Garrison.GetBuildingSpecInfo.lua b/api/C_Garrison.GetBuildingSpecInfo.lua new file mode 100644 index 0000000..969a305 --- /dev/null +++ b/api/C_Garrison.GetBuildingSpecInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetBuildingSpecInfo() end \ No newline at end of file diff --git a/api/C_Garrison.GetBuildingTimeRemaining.lua b/api/C_Garrison.GetBuildingTimeRemaining.lua new file mode 100644 index 0000000..9b26f85 --- /dev/null +++ b/api/C_Garrison.GetBuildingTimeRemaining.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetBuildingTimeRemaining() end \ No newline at end of file diff --git a/api/C_Garrison.GetBuildingTooltip.lua b/api/C_Garrison.GetBuildingTooltip.lua new file mode 100644 index 0000000..d02e89f --- /dev/null +++ b/api/C_Garrison.GetBuildingTooltip.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetBuildingTooltip() end \ No newline at end of file diff --git a/api/C_Garrison.GetBuildingUpgradeInfo.lua b/api/C_Garrison.GetBuildingUpgradeInfo.lua new file mode 100644 index 0000000..9d3c411 --- /dev/null +++ b/api/C_Garrison.GetBuildingUpgradeInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetBuildingUpgradeInfo() end \ No newline at end of file diff --git a/api/C_Garrison.GetBuildings.lua b/api/C_Garrison.GetBuildings.lua new file mode 100644 index 0000000..88683ab --- /dev/null +++ b/api/C_Garrison.GetBuildings.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetBuildings() end \ No newline at end of file diff --git a/api/C_Garrison.GetBuildingsForPlot.lua b/api/C_Garrison.GetBuildingsForPlot.lua new file mode 100644 index 0000000..d921db3 --- /dev/null +++ b/api/C_Garrison.GetBuildingsForPlot.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetBuildingsForPlot() end \ No newline at end of file diff --git a/api/C_Garrison.GetBuildingsForSize.lua b/api/C_Garrison.GetBuildingsForSize.lua new file mode 100644 index 0000000..7b2b812 --- /dev/null +++ b/api/C_Garrison.GetBuildingsForSize.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetBuildingsForSize() end \ No newline at end of file diff --git a/api/C_Garrison.GetCompleteMissions.lua b/api/C_Garrison.GetCompleteMissions.lua new file mode 100644 index 0000000..d38614c --- /dev/null +++ b/api/C_Garrison.GetCompleteMissions.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetCompleteMissions() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerAbilities.lua b/api/C_Garrison.GetFollowerAbilities.lua new file mode 100644 index 0000000..411c732 --- /dev/null +++ b/api/C_Garrison.GetFollowerAbilities.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerAbilities() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerAbilityAtIndex.lua b/api/C_Garrison.GetFollowerAbilityAtIndex.lua new file mode 100644 index 0000000..af1f411 --- /dev/null +++ b/api/C_Garrison.GetFollowerAbilityAtIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerAbilityAtIndex() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerAbilityAtIndexByID.lua b/api/C_Garrison.GetFollowerAbilityAtIndexByID.lua new file mode 100644 index 0000000..96617b1 --- /dev/null +++ b/api/C_Garrison.GetFollowerAbilityAtIndexByID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerAbilityAtIndexByID() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerAbilityCounterMechanicInfo.lua b/api/C_Garrison.GetFollowerAbilityCounterMechanicInfo.lua new file mode 100644 index 0000000..6951a5c --- /dev/null +++ b/api/C_Garrison.GetFollowerAbilityCounterMechanicInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerAbilityCounterMechanicInfo() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerAbilityDescription.lua b/api/C_Garrison.GetFollowerAbilityDescription.lua new file mode 100644 index 0000000..3853551 --- /dev/null +++ b/api/C_Garrison.GetFollowerAbilityDescription.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerAbilityDescription() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerAbilityIcon.lua b/api/C_Garrison.GetFollowerAbilityIcon.lua new file mode 100644 index 0000000..d87717a --- /dev/null +++ b/api/C_Garrison.GetFollowerAbilityIcon.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerAbilityIcon() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerAbilityIsTrait.lua b/api/C_Garrison.GetFollowerAbilityIsTrait.lua new file mode 100644 index 0000000..2b3b903 --- /dev/null +++ b/api/C_Garrison.GetFollowerAbilityIsTrait.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerAbilityIsTrait() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerAbilityLink.lua b/api/C_Garrison.GetFollowerAbilityLink.lua new file mode 100644 index 0000000..1568ddd --- /dev/null +++ b/api/C_Garrison.GetFollowerAbilityLink.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerAbilityLink() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerAbilityName.lua b/api/C_Garrison.GetFollowerAbilityName.lua new file mode 100644 index 0000000..d947d1f --- /dev/null +++ b/api/C_Garrison.GetFollowerAbilityName.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerAbilityName() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerActivationCost.lua b/api/C_Garrison.GetFollowerActivationCost.lua new file mode 100644 index 0000000..ccab169 --- /dev/null +++ b/api/C_Garrison.GetFollowerActivationCost.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerActivationCost() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerBiasForMission.lua b/api/C_Garrison.GetFollowerBiasForMission.lua new file mode 100644 index 0000000..71490a6 --- /dev/null +++ b/api/C_Garrison.GetFollowerBiasForMission.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerBiasForMission() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerClassSpec.lua b/api/C_Garrison.GetFollowerClassSpec.lua new file mode 100644 index 0000000..d3f98c1 --- /dev/null +++ b/api/C_Garrison.GetFollowerClassSpec.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerClassSpec() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerClassSpecAtlas.lua b/api/C_Garrison.GetFollowerClassSpecAtlas.lua new file mode 100644 index 0000000..26eeea3 --- /dev/null +++ b/api/C_Garrison.GetFollowerClassSpecAtlas.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerClassSpecAtlas() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerClassSpecByID.lua b/api/C_Garrison.GetFollowerClassSpecByID.lua new file mode 100644 index 0000000..8e2a989 --- /dev/null +++ b/api/C_Garrison.GetFollowerClassSpecByID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerClassSpecByID() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerClassSpecName.lua b/api/C_Garrison.GetFollowerClassSpecName.lua new file mode 100644 index 0000000..267a096 --- /dev/null +++ b/api/C_Garrison.GetFollowerClassSpecName.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerClassSpecName() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerDisplayID.lua b/api/C_Garrison.GetFollowerDisplayID.lua new file mode 100644 index 0000000..ec25cfb --- /dev/null +++ b/api/C_Garrison.GetFollowerDisplayID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerDisplayID() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerDisplayIDByID.lua b/api/C_Garrison.GetFollowerDisplayIDByID.lua new file mode 100644 index 0000000..885c026 --- /dev/null +++ b/api/C_Garrison.GetFollowerDisplayIDByID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerDisplayIDByID() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerInfo.lua b/api/C_Garrison.GetFollowerInfo.lua new file mode 100644 index 0000000..e0c5809 --- /dev/null +++ b/api/C_Garrison.GetFollowerInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerInfo() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerInfoForBuilding.lua b/api/C_Garrison.GetFollowerInfoForBuilding.lua new file mode 100644 index 0000000..c77833f --- /dev/null +++ b/api/C_Garrison.GetFollowerInfoForBuilding.lua @@ -0,0 +1,13 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param plotID number +---@return string name +---@return number level +---@return number quality +---@return number displayID +---@return number followerID +---@return string garrFollowerID +---@return number status +---@return number portraitIconID +---Returns info about a follower assigned to a building. This will return information about the follower (if any) assigned to the building on the specified plot. Note that this function takes a plot ID, not a building ID. To query for the follower at, say, the Enchanter's Study, one would have to first find the plot where the study is and then give that plot ID to this function. +function C_Garrison.GetFollowerInfoForBuilding(plotID) end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerItemLevelAverage.lua b/api/C_Garrison.GetFollowerItemLevelAverage.lua new file mode 100644 index 0000000..1dda0c0 --- /dev/null +++ b/api/C_Garrison.GetFollowerItemLevelAverage.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerItemLevelAverage() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerItems.lua b/api/C_Garrison.GetFollowerItems.lua new file mode 100644 index 0000000..5697b5a --- /dev/null +++ b/api/C_Garrison.GetFollowerItems.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerItems() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerLevel.lua b/api/C_Garrison.GetFollowerLevel.lua new file mode 100644 index 0000000..f41005f --- /dev/null +++ b/api/C_Garrison.GetFollowerLevel.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerLevel() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerLevelXP.lua b/api/C_Garrison.GetFollowerLevelXP.lua new file mode 100644 index 0000000..e5f2cb2 --- /dev/null +++ b/api/C_Garrison.GetFollowerLevelXP.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerLevelXP() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerLink.lua b/api/C_Garrison.GetFollowerLink.lua new file mode 100644 index 0000000..9ee0c90 --- /dev/null +++ b/api/C_Garrison.GetFollowerLink.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerLink() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerLinkByID.lua b/api/C_Garrison.GetFollowerLinkByID.lua new file mode 100644 index 0000000..1456ff2 --- /dev/null +++ b/api/C_Garrison.GetFollowerLinkByID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerLinkByID() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerMissionCompleteInfo.lua b/api/C_Garrison.GetFollowerMissionCompleteInfo.lua new file mode 100644 index 0000000..606402d --- /dev/null +++ b/api/C_Garrison.GetFollowerMissionCompleteInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerMissionCompleteInfo() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerModelItems.lua b/api/C_Garrison.GetFollowerModelItems.lua new file mode 100644 index 0000000..d1de6cf --- /dev/null +++ b/api/C_Garrison.GetFollowerModelItems.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerModelItems() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerName.lua b/api/C_Garrison.GetFollowerName.lua new file mode 100644 index 0000000..23528d5 --- /dev/null +++ b/api/C_Garrison.GetFollowerName.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerName() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerNameByID.lua b/api/C_Garrison.GetFollowerNameByID.lua new file mode 100644 index 0000000..7d05905 --- /dev/null +++ b/api/C_Garrison.GetFollowerNameByID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerNameByID() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerPortraitIconIDByID.lua b/api/C_Garrison.GetFollowerPortraitIconIDByID.lua new file mode 100644 index 0000000..edb3ffe --- /dev/null +++ b/api/C_Garrison.GetFollowerPortraitIconIDByID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerPortraitIconIDByID() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerQuality.lua b/api/C_Garrison.GetFollowerQuality.lua new file mode 100644 index 0000000..974d61a --- /dev/null +++ b/api/C_Garrison.GetFollowerQuality.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerQuality() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerQualityTable.lua b/api/C_Garrison.GetFollowerQualityTable.lua new file mode 100644 index 0000000..c019425 --- /dev/null +++ b/api/C_Garrison.GetFollowerQualityTable.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerQualityTable() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerSoftCap.lua b/api/C_Garrison.GetFollowerSoftCap.lua new file mode 100644 index 0000000..f7baa52 --- /dev/null +++ b/api/C_Garrison.GetFollowerSoftCap.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerSoftCap() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerSourceTextByID.lua b/api/C_Garrison.GetFollowerSourceTextByID.lua new file mode 100644 index 0000000..bdc5e1c --- /dev/null +++ b/api/C_Garrison.GetFollowerSourceTextByID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerSourceTextByID() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerStatus.lua b/api/C_Garrison.GetFollowerStatus.lua new file mode 100644 index 0000000..fbc1cff --- /dev/null +++ b/api/C_Garrison.GetFollowerStatus.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerStatus() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerTraitAtIndex.lua b/api/C_Garrison.GetFollowerTraitAtIndex.lua new file mode 100644 index 0000000..be8c6ff --- /dev/null +++ b/api/C_Garrison.GetFollowerTraitAtIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerTraitAtIndex() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerTraitAtIndexByID.lua b/api/C_Garrison.GetFollowerTraitAtIndexByID.lua new file mode 100644 index 0000000..67484b3 --- /dev/null +++ b/api/C_Garrison.GetFollowerTraitAtIndexByID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerTraitAtIndexByID() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerXP.lua b/api/C_Garrison.GetFollowerXP.lua new file mode 100644 index 0000000..b726557 --- /dev/null +++ b/api/C_Garrison.GetFollowerXP.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerXP() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowerXPTable.lua b/api/C_Garrison.GetFollowerXPTable.lua new file mode 100644 index 0000000..b24b2aa --- /dev/null +++ b/api/C_Garrison.GetFollowerXPTable.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowerXPTable() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowers.lua b/api/C_Garrison.GetFollowers.lua new file mode 100644 index 0000000..f0adcaf --- /dev/null +++ b/api/C_Garrison.GetFollowers.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowers() end \ No newline at end of file diff --git a/api/C_Garrison.GetFollowersTraitsForMission.lua b/api/C_Garrison.GetFollowersTraitsForMission.lua new file mode 100644 index 0000000..b7f2019 --- /dev/null +++ b/api/C_Garrison.GetFollowersTraitsForMission.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetFollowersTraitsForMission() end \ No newline at end of file diff --git a/api/C_Garrison.GetGarrisonInfo.lua b/api/C_Garrison.GetGarrisonInfo.lua new file mode 100644 index 0000000..156c6e8 --- /dev/null +++ b/api/C_Garrison.GetGarrisonInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetGarrisonInfo() end \ No newline at end of file diff --git a/api/C_Garrison.GetGarrisonUpgradeCost.lua b/api/C_Garrison.GetGarrisonUpgradeCost.lua new file mode 100644 index 0000000..5298d65 --- /dev/null +++ b/api/C_Garrison.GetGarrisonUpgradeCost.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetGarrisonUpgradeCost() end \ No newline at end of file diff --git a/api/C_Garrison.GetInProgressMissions.lua b/api/C_Garrison.GetInProgressMissions.lua new file mode 100644 index 0000000..24ebcf1 --- /dev/null +++ b/api/C_Garrison.GetInProgressMissions.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetInProgressMissions() end \ No newline at end of file diff --git a/api/C_Garrison.GetLandingPageItems.lua b/api/C_Garrison.GetLandingPageItems.lua new file mode 100644 index 0000000..44baed5 --- /dev/null +++ b/api/C_Garrison.GetLandingPageItems.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetLandingPageItems() end \ No newline at end of file diff --git a/api/C_Garrison.GetLandingPageShipmentCount.lua b/api/C_Garrison.GetLandingPageShipmentCount.lua new file mode 100644 index 0000000..008ad59 --- /dev/null +++ b/api/C_Garrison.GetLandingPageShipmentCount.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetLandingPageShipmentCount() end \ No newline at end of file diff --git a/api/C_Garrison.GetLandingPageShipmentInfo.lua b/api/C_Garrison.GetLandingPageShipmentInfo.lua new file mode 100644 index 0000000..efb9b13 --- /dev/null +++ b/api/C_Garrison.GetLandingPageShipmentInfo.lua @@ -0,0 +1,15 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string name +---@return string texture +---@return number shipmentCapacity +---@return number shipmentsTotal +---@return number creationTime +---@return number duration +---@return string timeLeftString +---@return string itemName +---@return string itemIcon +---@return number itemQuality +---@return number itemID +---Returns info about a particular Garrison Building's shipments. +function C_Garrison.GetLandingPageShipmentInfo() end \ No newline at end of file diff --git a/api/C_Garrison.GetMissionCompleteEncounters.lua b/api/C_Garrison.GetMissionCompleteEncounters.lua new file mode 100644 index 0000000..21f1ee5 --- /dev/null +++ b/api/C_Garrison.GetMissionCompleteEncounters.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetMissionCompleteEncounters() end \ No newline at end of file diff --git a/api/C_Garrison.GetMissionDisplayIDs.lua b/api/C_Garrison.GetMissionDisplayIDs.lua new file mode 100644 index 0000000..f1d83a7 --- /dev/null +++ b/api/C_Garrison.GetMissionDisplayIDs.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetMissionDisplayIDs() end \ No newline at end of file diff --git a/api/C_Garrison.GetMissionInfo.lua b/api/C_Garrison.GetMissionInfo.lua new file mode 100644 index 0000000..fd2f440 --- /dev/null +++ b/api/C_Garrison.GetMissionInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetMissionInfo() end \ No newline at end of file diff --git a/api/C_Garrison.GetMissionLink.lua b/api/C_Garrison.GetMissionLink.lua new file mode 100644 index 0000000..1374b9b --- /dev/null +++ b/api/C_Garrison.GetMissionLink.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetMissionLink() end \ No newline at end of file diff --git a/api/C_Garrison.GetMissionMaxFollowers.lua b/api/C_Garrison.GetMissionMaxFollowers.lua new file mode 100644 index 0000000..dc11856 --- /dev/null +++ b/api/C_Garrison.GetMissionMaxFollowers.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetMissionMaxFollowers() end \ No newline at end of file diff --git a/api/C_Garrison.GetMissionName.lua b/api/C_Garrison.GetMissionName.lua new file mode 100644 index 0000000..f2d0694 --- /dev/null +++ b/api/C_Garrison.GetMissionName.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetMissionName() end \ No newline at end of file diff --git a/api/C_Garrison.GetMissionRewardInfo.lua b/api/C_Garrison.GetMissionRewardInfo.lua new file mode 100644 index 0000000..e036fb8 --- /dev/null +++ b/api/C_Garrison.GetMissionRewardInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetMissionRewardInfo() end \ No newline at end of file diff --git a/api/C_Garrison.GetMissionTimes.lua b/api/C_Garrison.GetMissionTimes.lua new file mode 100644 index 0000000..6e48c22 --- /dev/null +++ b/api/C_Garrison.GetMissionTimes.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetMissionTimes() end \ No newline at end of file diff --git a/api/C_Garrison.GetMissionUncounteredMechanics.lua b/api/C_Garrison.GetMissionUncounteredMechanics.lua new file mode 100644 index 0000000..34e9bc9 --- /dev/null +++ b/api/C_Garrison.GetMissionUncounteredMechanics.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetMissionUncounteredMechanics() end \ No newline at end of file diff --git a/api/C_Garrison.GetNumActiveFollowers.lua b/api/C_Garrison.GetNumActiveFollowers.lua new file mode 100644 index 0000000..79bd609 --- /dev/null +++ b/api/C_Garrison.GetNumActiveFollowers.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetNumActiveFollowers() end \ No newline at end of file diff --git a/api/C_Garrison.GetNumFollowerActivationsRemaining.lua b/api/C_Garrison.GetNumFollowerActivationsRemaining.lua new file mode 100644 index 0000000..d58c414 --- /dev/null +++ b/api/C_Garrison.GetNumFollowerActivationsRemaining.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetNumFollowerActivationsRemaining() end \ No newline at end of file diff --git a/api/C_Garrison.GetNumFollowerDailyActivations.lua b/api/C_Garrison.GetNumFollowerDailyActivations.lua new file mode 100644 index 0000000..79bf6fa --- /dev/null +++ b/api/C_Garrison.GetNumFollowerDailyActivations.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetNumFollowerDailyActivations() end \ No newline at end of file diff --git a/api/C_Garrison.GetNumFollowers.lua b/api/C_Garrison.GetNumFollowers.lua new file mode 100644 index 0000000..edc7de7 --- /dev/null +++ b/api/C_Garrison.GetNumFollowers.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetNumFollowers() end \ No newline at end of file diff --git a/api/C_Garrison.GetNumFollowersOnMission.lua b/api/C_Garrison.GetNumFollowersOnMission.lua new file mode 100644 index 0000000..ac60122 --- /dev/null +++ b/api/C_Garrison.GetNumFollowersOnMission.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetNumFollowersOnMission() end \ No newline at end of file diff --git a/api/C_Garrison.GetNumPendingShipments.lua b/api/C_Garrison.GetNumPendingShipments.lua new file mode 100644 index 0000000..d722e0c --- /dev/null +++ b/api/C_Garrison.GetNumPendingShipments.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetNumPendingShipments() end \ No newline at end of file diff --git a/api/C_Garrison.GetNumShipmentReagents.lua b/api/C_Garrison.GetNumShipmentReagents.lua new file mode 100644 index 0000000..32d9329 --- /dev/null +++ b/api/C_Garrison.GetNumShipmentReagents.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetNumShipmentReagents() end \ No newline at end of file diff --git a/api/C_Garrison.GetOwnedBuildingInfo.lua b/api/C_Garrison.GetOwnedBuildingInfo.lua new file mode 100644 index 0000000..c854cc5 --- /dev/null +++ b/api/C_Garrison.GetOwnedBuildingInfo.lua @@ -0,0 +1,30 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param plotID number +---@return number buildingID +---@return string buildingName +---@return string texturePrefix +---@return string icon +---@return string description +---@return number rank +---@return number currencyID +---@return number currencyAmount +---@return number goldAmount +---@return string timeRequirement +---@return boolean needsPlan +---@return boolean isPreBuilt +---@return table possSpecs +---@return table upgrades +---@return boolean canUpgrade +---@return boolean isMaxLevel +---@return boolean hasFollowerSlot +---@return table knownSpecs +---@return number currentSpec +---@return numbernil specCooldown +---@return boolean isBeingBuilt +---@return number timeStarted +---@return number buildDuration +---@return string timeRemainingText +---@return boolean canCompleteBuild +---Returns information on a building in the character's garrison +function C_Garrison.GetOwnedBuildingInfo(plotID) end \ No newline at end of file diff --git a/api/C_Garrison.GetOwnedBuildingInfoAbbrev.lua b/api/C_Garrison.GetOwnedBuildingInfoAbbrev.lua new file mode 100644 index 0000000..d34fcce --- /dev/null +++ b/api/C_Garrison.GetOwnedBuildingInfoAbbrev.lua @@ -0,0 +1,16 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param plotID number +---@return number buildingID +---@return string buildingName +---@return string texturePrefix +---@return string icon +---@return number rank +---@return boolean isBeingBuilt +---@return number timeStarted +---@return number buildDuration +---@return boolean canCompleteBuild +---@return boolean canUpgrade +---@return boolean isPreBuilt +---Returns basic information on garrison buildings.. For additional information, see C_Garrison.GetOwnedBuildingInfo() +function C_Garrison.GetOwnedBuildingInfoAbbrev(plotID) end \ No newline at end of file diff --git a/api/C_Garrison.GetPartyBuffs.lua b/api/C_Garrison.GetPartyBuffs.lua new file mode 100644 index 0000000..bc2390e --- /dev/null +++ b/api/C_Garrison.GetPartyBuffs.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetPartyBuffs() end \ No newline at end of file diff --git a/api/C_Garrison.GetPartyMissionInfo.lua b/api/C_Garrison.GetPartyMissionInfo.lua new file mode 100644 index 0000000..7b3d6a5 --- /dev/null +++ b/api/C_Garrison.GetPartyMissionInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetPartyMissionInfo() end \ No newline at end of file diff --git a/api/C_Garrison.GetPendingShipmentInfo.lua b/api/C_Garrison.GetPendingShipmentInfo.lua new file mode 100644 index 0000000..69cc665 --- /dev/null +++ b/api/C_Garrison.GetPendingShipmentInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetPendingShipmentInfo() end \ No newline at end of file diff --git a/api/C_Garrison.GetPlots.lua b/api/C_Garrison.GetPlots.lua new file mode 100644 index 0000000..e94b136 --- /dev/null +++ b/api/C_Garrison.GetPlots.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetPlots() end \ No newline at end of file diff --git a/api/C_Garrison.GetPlotsForBuilding.lua b/api/C_Garrison.GetPlotsForBuilding.lua new file mode 100644 index 0000000..4acf08c --- /dev/null +++ b/api/C_Garrison.GetPlotsForBuilding.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetPlotsForBuilding() end \ No newline at end of file diff --git a/api/C_Garrison.GetPossibleFollowersForBuilding.lua b/api/C_Garrison.GetPossibleFollowersForBuilding.lua new file mode 100644 index 0000000..9e06e10 --- /dev/null +++ b/api/C_Garrison.GetPossibleFollowersForBuilding.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetPossibleFollowersForBuilding() end \ No newline at end of file diff --git a/api/C_Garrison.GetRecruitAbilities.lua b/api/C_Garrison.GetRecruitAbilities.lua new file mode 100644 index 0000000..53784d8 --- /dev/null +++ b/api/C_Garrison.GetRecruitAbilities.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetRecruitAbilities() end \ No newline at end of file diff --git a/api/C_Garrison.GetRecruiterAbilityCategories.lua b/api/C_Garrison.GetRecruiterAbilityCategories.lua new file mode 100644 index 0000000..78894c3 --- /dev/null +++ b/api/C_Garrison.GetRecruiterAbilityCategories.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetRecruiterAbilityCategories() end \ No newline at end of file diff --git a/api/C_Garrison.GetRecruiterAbilityList.lua b/api/C_Garrison.GetRecruiterAbilityList.lua new file mode 100644 index 0000000..182f4a5 --- /dev/null +++ b/api/C_Garrison.GetRecruiterAbilityList.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetRecruiterAbilityList() end \ No newline at end of file diff --git a/api/C_Garrison.GetRecruitmentPreferences.lua b/api/C_Garrison.GetRecruitmentPreferences.lua new file mode 100644 index 0000000..608adae --- /dev/null +++ b/api/C_Garrison.GetRecruitmentPreferences.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetRecruitmentPreferences() end \ No newline at end of file diff --git a/api/C_Garrison.GetRewardChance.lua b/api/C_Garrison.GetRewardChance.lua new file mode 100644 index 0000000..c42cfd1 --- /dev/null +++ b/api/C_Garrison.GetRewardChance.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetRewardChance() end \ No newline at end of file diff --git a/api/C_Garrison.GetShipmentContainerInfo.lua b/api/C_Garrison.GetShipmentContainerInfo.lua new file mode 100644 index 0000000..2093f39 --- /dev/null +++ b/api/C_Garrison.GetShipmentContainerInfo.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string prefix +---@return string pendingText +---@return string description +---Returns text used by the work order UI. +function C_Garrison.GetShipmentContainerInfo() end \ No newline at end of file diff --git a/api/C_Garrison.GetShipmentItemInfo.lua b/api/C_Garrison.GetShipmentItemInfo.lua new file mode 100644 index 0000000..c4c1a4f --- /dev/null +++ b/api/C_Garrison.GetShipmentItemInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetShipmentItemInfo() end \ No newline at end of file diff --git a/api/C_Garrison.GetShipmentReagentCurrencyInfo.lua b/api/C_Garrison.GetShipmentReagentCurrencyInfo.lua new file mode 100644 index 0000000..47b11cb --- /dev/null +++ b/api/C_Garrison.GetShipmentReagentCurrencyInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetShipmentReagentCurrencyInfo() end \ No newline at end of file diff --git a/api/C_Garrison.GetShipmentReagentInfo.lua b/api/C_Garrison.GetShipmentReagentInfo.lua new file mode 100644 index 0000000..7973805 --- /dev/null +++ b/api/C_Garrison.GetShipmentReagentInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetShipmentReagentInfo() end \ No newline at end of file diff --git a/api/C_Garrison.GetShipmentReagentItemLink.lua b/api/C_Garrison.GetShipmentReagentItemLink.lua new file mode 100644 index 0000000..bf86e18 --- /dev/null +++ b/api/C_Garrison.GetShipmentReagentItemLink.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetShipmentReagentItemLink() end \ No newline at end of file diff --git a/api/C_Garrison.GetSpecChangeCost.lua b/api/C_Garrison.GetSpecChangeCost.lua new file mode 100644 index 0000000..e479d8e --- /dev/null +++ b/api/C_Garrison.GetSpecChangeCost.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetSpecChangeCost() end \ No newline at end of file diff --git a/api/C_Garrison.GetTabForPlot.lua b/api/C_Garrison.GetTabForPlot.lua new file mode 100644 index 0000000..26d2c19 --- /dev/null +++ b/api/C_Garrison.GetTabForPlot.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.GetTabForPlot() end \ No newline at end of file diff --git a/api/C_Garrison.IsAboveFollowerSoftCap.lua b/api/C_Garrison.IsAboveFollowerSoftCap.lua new file mode 100644 index 0000000..0f16435 --- /dev/null +++ b/api/C_Garrison.IsAboveFollowerSoftCap.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.IsAboveFollowerSoftCap() end \ No newline at end of file diff --git a/api/C_Garrison.IsFollowerCollected.lua b/api/C_Garrison.IsFollowerCollected.lua new file mode 100644 index 0000000..266344a --- /dev/null +++ b/api/C_Garrison.IsFollowerCollected.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.IsFollowerCollected() end \ No newline at end of file diff --git a/api/C_Garrison.IsFollowerUnique.lua b/api/C_Garrison.IsFollowerUnique.lua new file mode 100644 index 0000000..32296f0 --- /dev/null +++ b/api/C_Garrison.IsFollowerUnique.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.IsFollowerUnique() end \ No newline at end of file diff --git a/api/C_Garrison.IsInvasionAvailable.lua b/api/C_Garrison.IsInvasionAvailable.lua new file mode 100644 index 0000000..a5a81a1 --- /dev/null +++ b/api/C_Garrison.IsInvasionAvailable.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.IsInvasionAvailable() end \ No newline at end of file diff --git a/api/C_Garrison.IsOnGarrisonMap.lua b/api/C_Garrison.IsOnGarrisonMap.lua new file mode 100644 index 0000000..3ae6dcb --- /dev/null +++ b/api/C_Garrison.IsOnGarrisonMap.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.IsOnGarrisonMap() end \ No newline at end of file diff --git a/api/C_Garrison.IsUsingPartyGarrison.lua b/api/C_Garrison.IsUsingPartyGarrison.lua new file mode 100644 index 0000000..a6e79af --- /dev/null +++ b/api/C_Garrison.IsUsingPartyGarrison.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.IsUsingPartyGarrison() end \ No newline at end of file diff --git a/api/C_Garrison.IsVisitGarrisonAvailable.lua b/api/C_Garrison.IsVisitGarrisonAvailable.lua new file mode 100644 index 0000000..e9b28ce --- /dev/null +++ b/api/C_Garrison.IsVisitGarrisonAvailable.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.IsVisitGarrisonAvailable() end \ No newline at end of file diff --git a/api/C_Garrison.MarkMissionComplete.lua b/api/C_Garrison.MarkMissionComplete.lua new file mode 100644 index 0000000..cc654d2 --- /dev/null +++ b/api/C_Garrison.MarkMissionComplete.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.MarkMissionComplete() end \ No newline at end of file diff --git a/api/C_Garrison.MissionBonusRoll.lua b/api/C_Garrison.MissionBonusRoll.lua new file mode 100644 index 0000000..a92bffd --- /dev/null +++ b/api/C_Garrison.MissionBonusRoll.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.MissionBonusRoll() end \ No newline at end of file diff --git a/api/C_Garrison.PlaceBuilding.lua b/api/C_Garrison.PlaceBuilding.lua new file mode 100644 index 0000000..0467c1c --- /dev/null +++ b/api/C_Garrison.PlaceBuilding.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.PlaceBuilding() end \ No newline at end of file diff --git a/api/C_Garrison.RecruitFollower.lua b/api/C_Garrison.RecruitFollower.lua new file mode 100644 index 0000000..3bee38b --- /dev/null +++ b/api/C_Garrison.RecruitFollower.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.RecruitFollower() end \ No newline at end of file diff --git a/api/C_Garrison.RemoveFollower.lua b/api/C_Garrison.RemoveFollower.lua new file mode 100644 index 0000000..178643f --- /dev/null +++ b/api/C_Garrison.RemoveFollower.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.RemoveFollower() end \ No newline at end of file diff --git a/api/C_Garrison.RemoveFollowerFromBuilding.lua b/api/C_Garrison.RemoveFollowerFromBuilding.lua new file mode 100644 index 0000000..ae76ac9 --- /dev/null +++ b/api/C_Garrison.RemoveFollowerFromBuilding.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.RemoveFollowerFromBuilding() end \ No newline at end of file diff --git a/api/C_Garrison.RemoveFollowerFromMission.lua b/api/C_Garrison.RemoveFollowerFromMission.lua new file mode 100644 index 0000000..2ae9fad --- /dev/null +++ b/api/C_Garrison.RemoveFollowerFromMission.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.RemoveFollowerFromMission() end \ No newline at end of file diff --git a/api/C_Garrison.RequestGarrisonUpgradeable.lua b/api/C_Garrison.RequestGarrisonUpgradeable.lua new file mode 100644 index 0000000..2b394f9 --- /dev/null +++ b/api/C_Garrison.RequestGarrisonUpgradeable.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.RequestGarrisonUpgradeable() end \ No newline at end of file diff --git a/api/C_Garrison.RequestLandingPageShipmentInfo.lua b/api/C_Garrison.RequestLandingPageShipmentInfo.lua new file mode 100644 index 0000000..038e668 --- /dev/null +++ b/api/C_Garrison.RequestLandingPageShipmentInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.RequestLandingPageShipmentInfo() end \ No newline at end of file diff --git a/api/C_Garrison.RequestShipmentCreation.lua b/api/C_Garrison.RequestShipmentCreation.lua new file mode 100644 index 0000000..fad9ab1 --- /dev/null +++ b/api/C_Garrison.RequestShipmentCreation.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.RequestShipmentCreation() end \ No newline at end of file diff --git a/api/C_Garrison.RequestShipmentInfo.lua b/api/C_Garrison.RequestShipmentInfo.lua new file mode 100644 index 0000000..759a1e0 --- /dev/null +++ b/api/C_Garrison.RequestShipmentInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.RequestShipmentInfo() end \ No newline at end of file diff --git a/api/C_Garrison.SearchForFollower.lua b/api/C_Garrison.SearchForFollower.lua new file mode 100644 index 0000000..3f2cead --- /dev/null +++ b/api/C_Garrison.SearchForFollower.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.SearchForFollower() end \ No newline at end of file diff --git a/api/C_Garrison.SetBuildingActive.lua b/api/C_Garrison.SetBuildingActive.lua new file mode 100644 index 0000000..669f3f0 --- /dev/null +++ b/api/C_Garrison.SetBuildingActive.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.SetBuildingActive() end \ No newline at end of file diff --git a/api/C_Garrison.SetBuildingSpecialization.lua b/api/C_Garrison.SetBuildingSpecialization.lua new file mode 100644 index 0000000..ebf4cac --- /dev/null +++ b/api/C_Garrison.SetBuildingSpecialization.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.SetBuildingSpecialization() end \ No newline at end of file diff --git a/api/C_Garrison.SetFollowerFavorite.lua b/api/C_Garrison.SetFollowerFavorite.lua new file mode 100644 index 0000000..161cf4a --- /dev/null +++ b/api/C_Garrison.SetFollowerFavorite.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.SetFollowerFavorite() end \ No newline at end of file diff --git a/api/C_Garrison.SetFollowerInactive.lua b/api/C_Garrison.SetFollowerInactive.lua new file mode 100644 index 0000000..591bd52 --- /dev/null +++ b/api/C_Garrison.SetFollowerInactive.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.SetFollowerInactive() end \ No newline at end of file diff --git a/api/C_Garrison.SetRecruitmentPreferences.lua b/api/C_Garrison.SetRecruitmentPreferences.lua new file mode 100644 index 0000000..9d72077 --- /dev/null +++ b/api/C_Garrison.SetRecruitmentPreferences.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.SetRecruitmentPreferences() end \ No newline at end of file diff --git a/api/C_Garrison.SetUsingPartyGarrison.lua b/api/C_Garrison.SetUsingPartyGarrison.lua new file mode 100644 index 0000000..2c3d603 --- /dev/null +++ b/api/C_Garrison.SetUsingPartyGarrison.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.SetUsingPartyGarrison() end \ No newline at end of file diff --git a/api/C_Garrison.StartMission.lua b/api/C_Garrison.StartMission.lua new file mode 100644 index 0000000..2b4f774 --- /dev/null +++ b/api/C_Garrison.StartMission.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.StartMission() end \ No newline at end of file diff --git a/api/C_Garrison.SwapBuildings.lua b/api/C_Garrison.SwapBuildings.lua new file mode 100644 index 0000000..574871c --- /dev/null +++ b/api/C_Garrison.SwapBuildings.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.SwapBuildings() end \ No newline at end of file diff --git a/api/C_Garrison.UpgradeBuilding.lua b/api/C_Garrison.UpgradeBuilding.lua new file mode 100644 index 0000000..ee5ec9f --- /dev/null +++ b/api/C_Garrison.UpgradeBuilding.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.UpgradeBuilding() end \ No newline at end of file diff --git a/api/C_Garrison.UpgradeGarrison.lua b/api/C_Garrison.UpgradeGarrison.lua new file mode 100644 index 0000000..9fef0e8 --- /dev/null +++ b/api/C_Garrison.UpgradeGarrison.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Garrison.UpgradeGarrison() end \ No newline at end of file diff --git a/api/C_LFGList.AcceptInvite.lua b/api/C_LFGList.AcceptInvite.lua new file mode 100644 index 0000000..2e5449b --- /dev/null +++ b/api/C_LFGList.AcceptInvite.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.AcceptInvite() end \ No newline at end of file diff --git a/api/C_LFGList.ApplyToGroup.lua b/api/C_LFGList.ApplyToGroup.lua new file mode 100644 index 0000000..e70efce --- /dev/null +++ b/api/C_LFGList.ApplyToGroup.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.ApplyToGroup() end \ No newline at end of file diff --git a/api/C_LFGList.CancelApplication.lua b/api/C_LFGList.CancelApplication.lua new file mode 100644 index 0000000..87b540d --- /dev/null +++ b/api/C_LFGList.CancelApplication.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.CancelApplication() end \ No newline at end of file diff --git a/api/C_LFGList.ClearSearchResults.lua b/api/C_LFGList.ClearSearchResults.lua new file mode 100644 index 0000000..fff07d3 --- /dev/null +++ b/api/C_LFGList.ClearSearchResults.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.ClearSearchResults() end \ No newline at end of file diff --git a/api/C_LFGList.CreateListing.lua b/api/C_LFGList.CreateListing.lua new file mode 100644 index 0000000..d6ee31b --- /dev/null +++ b/api/C_LFGList.CreateListing.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.CreateListing() end \ No newline at end of file diff --git a/api/C_LFGList.DeclineApplicant.lua b/api/C_LFGList.DeclineApplicant.lua new file mode 100644 index 0000000..a853c07 --- /dev/null +++ b/api/C_LFGList.DeclineApplicant.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.DeclineApplicant() end \ No newline at end of file diff --git a/api/C_LFGList.DeclineInvite.lua b/api/C_LFGList.DeclineInvite.lua new file mode 100644 index 0000000..0569f7c --- /dev/null +++ b/api/C_LFGList.DeclineInvite.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.DeclineInvite() end \ No newline at end of file diff --git a/api/C_LFGList.GetActiveEntryInfo.lua b/api/C_LFGList.GetActiveEntryInfo.lua new file mode 100644 index 0000000..6c42352 --- /dev/null +++ b/api/C_LFGList.GetActiveEntryInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---returns boolean on whether activity is active or not +function C_LFGList.GetActiveEntryInfo() end \ No newline at end of file diff --git a/api/C_LFGList.GetActivityGroupInfo.lua b/api/C_LFGList.GetActivityGroupInfo.lua new file mode 100644 index 0000000..2fa7d03 --- /dev/null +++ b/api/C_LFGList.GetActivityGroupInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---returns a string describing activity associated with activity_ID. Example local info = C_LFGList.GetActivityGroupInfo(16); returns: Naxxramas +function C_LFGList.GetActivityGroupInfo() end \ No newline at end of file diff --git a/api/C_LFGList.GetActivityInfo.lua b/api/C_LFGList.GetActivityInfo.lua new file mode 100644 index 0000000..d71af16 --- /dev/null +++ b/api/C_LFGList.GetActivityInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.GetActivityInfo() end \ No newline at end of file diff --git a/api/C_LFGList.GetActivityInfoExpensive.lua b/api/C_LFGList.GetActivityInfoExpensive.lua new file mode 100644 index 0000000..2a3913b --- /dev/null +++ b/api/C_LFGList.GetActivityInfoExpensive.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.GetActivityInfoExpensive() end \ No newline at end of file diff --git a/api/C_LFGList.GetApplicantInfo.lua b/api/C_LFGList.GetApplicantInfo.lua new file mode 100644 index 0000000..828e8d0 --- /dev/null +++ b/api/C_LFGList.GetApplicantInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.GetApplicantInfo() end \ No newline at end of file diff --git a/api/C_LFGList.GetApplicantMemberInfo.lua b/api/C_LFGList.GetApplicantMemberInfo.lua new file mode 100644 index 0000000..e829b3e --- /dev/null +++ b/api/C_LFGList.GetApplicantMemberInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.GetApplicantMemberInfo() end \ No newline at end of file diff --git a/api/C_LFGList.GetApplicantMemberStats.lua b/api/C_LFGList.GetApplicantMemberStats.lua new file mode 100644 index 0000000..c13fc48 --- /dev/null +++ b/api/C_LFGList.GetApplicantMemberStats.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.GetApplicantMemberStats() end \ No newline at end of file diff --git a/api/C_LFGList.GetApplicants.lua b/api/C_LFGList.GetApplicants.lua new file mode 100644 index 0000000..5387e92 --- /dev/null +++ b/api/C_LFGList.GetApplicants.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.GetApplicants() end \ No newline at end of file diff --git a/api/C_LFGList.GetApplicationInfo.lua b/api/C_LFGList.GetApplicationInfo.lua new file mode 100644 index 0000000..db30795 --- /dev/null +++ b/api/C_LFGList.GetApplicationInfo.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param groupID number +---@return number groupID +---@return string status +---@return nil unknown +---@return number timeRemaining +---@return string role +---Takes a group ID and returns the status of the application +function C_LFGList.GetApplicationInfo(groupID) end \ No newline at end of file diff --git a/api/C_LFGList.GetApplications.lua b/api/C_LFGList.GetApplications.lua new file mode 100644 index 0000000..19c3cb2 --- /dev/null +++ b/api/C_LFGList.GetApplications.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return table applications +---Returns a table with the groups the player has applied for +function C_LFGList.GetApplications() end \ No newline at end of file diff --git a/api/C_LFGList.GetAvailableActivities.lua b/api/C_LFGList.GetAvailableActivities.lua new file mode 100644 index 0000000..914cc9f --- /dev/null +++ b/api/C_LFGList.GetAvailableActivities.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---returns table of ID's for available activities +function C_LFGList.GetAvailableActivities() end \ No newline at end of file diff --git a/api/C_LFGList.GetAvailableActivityGroups.lua b/api/C_LFGList.GetAvailableActivityGroups.lua new file mode 100644 index 0000000..25a2c32 --- /dev/null +++ b/api/C_LFGList.GetAvailableActivityGroups.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.GetAvailableActivityGroups() end \ No newline at end of file diff --git a/api/C_LFGList.GetAvailableCategories.lua b/api/C_LFGList.GetAvailableCategories.lua new file mode 100644 index 0000000..725b869 --- /dev/null +++ b/api/C_LFGList.GetAvailableCategories.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.GetAvailableCategories() end \ No newline at end of file diff --git a/api/C_LFGList.GetAvailableRoles.lua b/api/C_LFGList.GetAvailableRoles.lua new file mode 100644 index 0000000..58a1284 --- /dev/null +++ b/api/C_LFGList.GetAvailableRoles.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.GetAvailableRoles() end \ No newline at end of file diff --git a/api/C_LFGList.GetCategoryInfo.lua b/api/C_LFGList.GetCategoryInfo.lua new file mode 100644 index 0000000..556bed9 --- /dev/null +++ b/api/C_LFGList.GetCategoryInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.GetCategoryInfo() end \ No newline at end of file diff --git a/api/C_LFGList.GetNumApplicants.lua b/api/C_LFGList.GetNumApplicants.lua new file mode 100644 index 0000000..0b1957f --- /dev/null +++ b/api/C_LFGList.GetNumApplicants.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.GetNumApplicants() end \ No newline at end of file diff --git a/api/C_LFGList.GetNumApplications.lua b/api/C_LFGList.GetNumApplications.lua new file mode 100644 index 0000000..9da03ca --- /dev/null +++ b/api/C_LFGList.GetNumApplications.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numApplications +---Returns the number of groups the player has applied for. +function C_LFGList.GetNumApplications() end \ No newline at end of file diff --git a/api/C_LFGList.GetNumInvitedApplicantMembers.lua b/api/C_LFGList.GetNumInvitedApplicantMembers.lua new file mode 100644 index 0000000..0568b6e --- /dev/null +++ b/api/C_LFGList.GetNumInvitedApplicantMembers.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.GetNumInvitedApplicantMembers() end \ No newline at end of file diff --git a/api/C_LFGList.GetRoleCheckInfo.lua b/api/C_LFGList.GetRoleCheckInfo.lua new file mode 100644 index 0000000..7116670 --- /dev/null +++ b/api/C_LFGList.GetRoleCheckInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.GetRoleCheckInfo() end \ No newline at end of file diff --git a/api/C_LFGList.GetSearchResultEncounterInfo.lua b/api/C_LFGList.GetSearchResultEncounterInfo.lua new file mode 100644 index 0000000..01bd4ab --- /dev/null +++ b/api/C_LFGList.GetSearchResultEncounterInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Takes a group id and returns a table with the encounter info of the group +function C_LFGList.GetSearchResultEncounterInfo() end \ No newline at end of file diff --git a/api/C_LFGList.GetSearchResultFriends.lua b/api/C_LFGList.GetSearchResultFriends.lua new file mode 100644 index 0000000..448089b --- /dev/null +++ b/api/C_LFGList.GetSearchResultFriends.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---returns table pairs #:NameOfFriend. a = C_LFGList.GetSearchResultFriends(resultID); for d,x in pairs(a) do ChatFrame1:AddMessage(d..":"..x); end -------- Output ------- 1:NameOfFriend 2:NameOfFriend ..etc +function C_LFGList.GetSearchResultFriends() end \ No newline at end of file diff --git a/api/C_LFGList.GetSearchResultInfo.lua b/api/C_LFGList.GetSearchResultInfo.lua new file mode 100644 index 0000000..0dd0687 --- /dev/null +++ b/api/C_LFGList.GetSearchResultInfo.lua @@ -0,0 +1,18 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number id +---@return unknown +---@return string name +---@return string desc +---@return unknown +---@return number ilvl +---@return number time +---@return unknown +---@return unknown +---@return unknown +---@return unknown +---@return string leader +---@return number members +---@return unknown +---Takes a group id and returns data on the group +function C_LFGList.GetSearchResultInfo() end \ No newline at end of file diff --git a/api/C_LFGList.GetSearchResultMemberCounts.lua b/api/C_LFGList.GetSearchResultMemberCounts.lua new file mode 100644 index 0000000..e5afe69 --- /dev/null +++ b/api/C_LFGList.GetSearchResultMemberCounts.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---return table . local a = CLFGList.GetSearchResultMemberCounts(searchresult_id); for b,c in pairs(a) do ChatFrame1:AddMessage(d..":"..x); end ------------- Outputs -------------------- HUNTER:1 WARRIOR:1 PALADIN:0 DAMAGER:2 PRIEST:0 HEALER:0 NOROLE:0 TANK:1 MAGE:0 WARLOCK:1 SHAMAN:0 DEATHKNIGHT:0 DRUID:0 MONK:0 ROGUE:0 +function C_LFGList.GetSearchResultMemberCounts() end \ No newline at end of file diff --git a/api/C_LFGList.GetSearchResultMemberInfo.lua b/api/C_LFGList.GetSearchResultMemberInfo.lua new file mode 100644 index 0000000..8adced3 --- /dev/null +++ b/api/C_LFGList.GetSearchResultMemberInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---given groupid and memberindex, returns member_role such as DAMAGER,TANK,HEALER +function C_LFGList.GetSearchResultMemberInfo() end \ No newline at end of file diff --git a/api/C_LFGList.GetSearchResults.lua b/api/C_LFGList.GetSearchResults.lua new file mode 100644 index 0000000..8a5b6a2 --- /dev/null +++ b/api/C_LFGList.GetSearchResults.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number groups +---@return table groupIDs +---Returns the number of groups listed and a table containing group ids of all enlisted groups +function C_LFGList.GetSearchResults() end \ No newline at end of file diff --git a/api/C_LFGList.HasActivityList.lua b/api/C_LFGList.HasActivityList.lua new file mode 100644 index 0000000..3729bc6 --- /dev/null +++ b/api/C_LFGList.HasActivityList.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.HasActivityList() end \ No newline at end of file diff --git a/api/C_LFGList.InviteApplicant.lua b/api/C_LFGList.InviteApplicant.lua new file mode 100644 index 0000000..2ae3f92 --- /dev/null +++ b/api/C_LFGList.InviteApplicant.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.InviteApplicant() end \ No newline at end of file diff --git a/api/C_LFGList.IsCurrentlyApplying.lua b/api/C_LFGList.IsCurrentlyApplying.lua new file mode 100644 index 0000000..072395f --- /dev/null +++ b/api/C_LFGList.IsCurrentlyApplying.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.IsCurrentlyApplying() end \ No newline at end of file diff --git a/api/C_LFGList.RefreshApplicants.lua b/api/C_LFGList.RefreshApplicants.lua new file mode 100644 index 0000000..564fc53 --- /dev/null +++ b/api/C_LFGList.RefreshApplicants.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.RefreshApplicants() end \ No newline at end of file diff --git a/api/C_LFGList.RemoveApplicant.lua b/api/C_LFGList.RemoveApplicant.lua new file mode 100644 index 0000000..2aec907 --- /dev/null +++ b/api/C_LFGList.RemoveApplicant.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.RemoveApplicant() end \ No newline at end of file diff --git a/api/C_LFGList.RemoveListing.lua b/api/C_LFGList.RemoveListing.lua new file mode 100644 index 0000000..a1eca4b --- /dev/null +++ b/api/C_LFGList.RemoveListing.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.RemoveListing() end \ No newline at end of file diff --git a/api/C_LFGList.ReportApplicant.lua b/api/C_LFGList.ReportApplicant.lua new file mode 100644 index 0000000..a0338c7 --- /dev/null +++ b/api/C_LFGList.ReportApplicant.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.ReportApplicant() end \ No newline at end of file diff --git a/api/C_LFGList.ReportSearchResult.lua b/api/C_LFGList.ReportSearchResult.lua new file mode 100644 index 0000000..8fda41d --- /dev/null +++ b/api/C_LFGList.ReportSearchResult.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.ReportSearchResult() end \ No newline at end of file diff --git a/api/C_LFGList.RequestAvailableActivities.lua b/api/C_LFGList.RequestAvailableActivities.lua new file mode 100644 index 0000000..cd46d3a --- /dev/null +++ b/api/C_LFGList.RequestAvailableActivities.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.RequestAvailableActivities() end \ No newline at end of file diff --git a/api/C_LFGList.Search.lua b/api/C_LFGList.Search.lua new file mode 100644 index 0000000..7e98a01 --- /dev/null +++ b/api/C_LFGList.Search.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.Search() end \ No newline at end of file diff --git a/api/C_LFGList.SetApplicantMemberRole.lua b/api/C_LFGList.SetApplicantMemberRole.lua new file mode 100644 index 0000000..b4523d1 --- /dev/null +++ b/api/C_LFGList.SetApplicantMemberRole.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.SetApplicantMemberRole() end \ No newline at end of file diff --git a/api/C_LFGList.UpdateListing.lua b/api/C_LFGList.UpdateListing.lua new file mode 100644 index 0000000..d95412a --- /dev/null +++ b/api/C_LFGList.UpdateListing.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LFGList.UpdateListing() end \ No newline at end of file diff --git a/api/C_LootHistory.CanMasterLoot.lua b/api/C_LootHistory.CanMasterLoot.lua new file mode 100644 index 0000000..17195a9 --- /dev/null +++ b/api/C_LootHistory.CanMasterLoot.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LootHistory.CanMasterLoot() end \ No newline at end of file diff --git a/api/C_LootHistory.GetExpiration.lua b/api/C_LootHistory.GetExpiration.lua new file mode 100644 index 0000000..ee2067a --- /dev/null +++ b/api/C_LootHistory.GetExpiration.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LootHistory.GetExpiration() end \ No newline at end of file diff --git a/api/C_LootHistory.GetItem.lua b/api/C_LootHistory.GetItem.lua new file mode 100644 index 0000000..c678514 --- /dev/null +++ b/api/C_LootHistory.GetItem.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LootHistory.GetItem() end \ No newline at end of file diff --git a/api/C_LootHistory.GetNumItems.lua b/api/C_LootHistory.GetNumItems.lua new file mode 100644 index 0000000..eafa1d1 --- /dev/null +++ b/api/C_LootHistory.GetNumItems.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LootHistory.GetNumItems() end \ No newline at end of file diff --git a/api/C_LootHistory.GetPlayerInfo.lua b/api/C_LootHistory.GetPlayerInfo.lua new file mode 100644 index 0000000..a7e4471 --- /dev/null +++ b/api/C_LootHistory.GetPlayerInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LootHistory.GetPlayerInfo() end \ No newline at end of file diff --git a/api/C_LootHistory.GiveMasterLoot.lua b/api/C_LootHistory.GiveMasterLoot.lua new file mode 100644 index 0000000..aaf57e9 --- /dev/null +++ b/api/C_LootHistory.GiveMasterLoot.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LootHistory.GiveMasterLoot() end \ No newline at end of file diff --git a/api/C_LootHistory.SetExpiration.lua b/api/C_LootHistory.SetExpiration.lua new file mode 100644 index 0000000..7db226c --- /dev/null +++ b/api/C_LootHistory.SetExpiration.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LootHistory.SetExpiration() end \ No newline at end of file diff --git a/api/C_LossOfControl.GetEventInfo.lua b/api/C_LossOfControl.GetEventInfo.lua new file mode 100644 index 0000000..514b126 --- /dev/null +++ b/api/C_LossOfControl.GetEventInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LossOfControl.GetEventInfo() end \ No newline at end of file diff --git a/api/C_LossOfControl.GetNumEvents.lua b/api/C_LossOfControl.GetNumEvents.lua new file mode 100644 index 0000000..ed1f2cf --- /dev/null +++ b/api/C_LossOfControl.GetNumEvents.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_LossOfControl.GetNumEvents() end \ No newline at end of file diff --git a/api/C_MapBar.BarIsShown.lua b/api/C_MapBar.BarIsShown.lua new file mode 100644 index 0000000..897ba19 --- /dev/null +++ b/api/C_MapBar.BarIsShown.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_MapBar.BarIsShown() end \ No newline at end of file diff --git a/api/C_MapBar.GetCurrentValue.lua b/api/C_MapBar.GetCurrentValue.lua new file mode 100644 index 0000000..b9b5f21 --- /dev/null +++ b/api/C_MapBar.GetCurrentValue.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_MapBar.GetCurrentValue() end \ No newline at end of file diff --git a/api/C_MapBar.GetMaxValue.lua b/api/C_MapBar.GetMaxValue.lua new file mode 100644 index 0000000..e93aea3 --- /dev/null +++ b/api/C_MapBar.GetMaxValue.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_MapBar.GetMaxValue() end \ No newline at end of file diff --git a/api/C_MapBar.GetParticipationPercentage.lua b/api/C_MapBar.GetParticipationPercentage.lua new file mode 100644 index 0000000..71ce148 --- /dev/null +++ b/api/C_MapBar.GetParticipationPercentage.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_MapBar.GetParticipationPercentage() end \ No newline at end of file diff --git a/api/C_MapBar.GetPhaseIndex.lua b/api/C_MapBar.GetPhaseIndex.lua new file mode 100644 index 0000000..c864951 --- /dev/null +++ b/api/C_MapBar.GetPhaseIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_MapBar.GetPhaseIndex() end \ No newline at end of file diff --git a/api/C_MapBar.GetTag.lua b/api/C_MapBar.GetTag.lua new file mode 100644 index 0000000..d158aa4 --- /dev/null +++ b/api/C_MapBar.GetTag.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_MapBar.GetTag() end \ No newline at end of file diff --git a/api/C_MountJournal.Dismiss.lua b/api/C_MountJournal.Dismiss.lua new file mode 100644 index 0000000..c2a1a42 --- /dev/null +++ b/api/C_MountJournal.Dismiss.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_MountJournal.Dismiss() end \ No newline at end of file diff --git a/api/C_MountJournal.GetCollectedFilterSetting.lua b/api/C_MountJournal.GetCollectedFilterSetting.lua new file mode 100644 index 0000000..ca0a25a --- /dev/null +++ b/api/C_MountJournal.GetCollectedFilterSetting.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_MountJournal.GetCollectedFilterSetting() end \ No newline at end of file diff --git a/api/C_MountJournal.GetIsFavorite.lua b/api/C_MountJournal.GetIsFavorite.lua new file mode 100644 index 0000000..a276f1d --- /dev/null +++ b/api/C_MountJournal.GetIsFavorite.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_MountJournal.GetIsFavorite() end \ No newline at end of file diff --git a/api/C_MountJournal.GetMountInfo.lua b/api/C_MountJournal.GetMountInfo.lua new file mode 100644 index 0000000..9463ede --- /dev/null +++ b/api/C_MountJournal.GetMountInfo.lua @@ -0,0 +1,29 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string creatureName +---@return number spellID +---@return string icon +---@return boolean active +---@return boolean summonable +---@return 10 source +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---@return 5 +---@return 6 +---@return 7 +---@return 8 +---@return 9 +---@return 10 +---@return boolean isFavorite +---@return boolean isFactionSpecific +---@return nil faction +---@return 0 +---@return 1 +---@return nil +---@return boolean unknown +---@return boolean owned +---Returns information about a mount. +function C_MountJournal.GetMountInfo(index) end \ No newline at end of file diff --git a/api/C_MountJournal.GetMountInfoExtra.lua b/api/C_MountJournal.GetMountInfoExtra.lua new file mode 100644 index 0000000..7396a5f --- /dev/null +++ b/api/C_MountJournal.GetMountInfoExtra.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_MountJournal.GetMountInfoExtra() end \ No newline at end of file diff --git a/api/C_MountJournal.GetNumMounts.lua b/api/C_MountJournal.GetNumMounts.lua new file mode 100644 index 0000000..368156e --- /dev/null +++ b/api/C_MountJournal.GetNumMounts.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_MountJournal.GetNumMounts() end \ No newline at end of file diff --git a/api/C_MountJournal.Pickup.lua b/api/C_MountJournal.Pickup.lua new file mode 100644 index 0000000..9ab217f --- /dev/null +++ b/api/C_MountJournal.Pickup.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_MountJournal.Pickup() end \ No newline at end of file diff --git a/api/C_MountJournal.SetCollectedFilterSetting.lua b/api/C_MountJournal.SetCollectedFilterSetting.lua new file mode 100644 index 0000000..bf10708 --- /dev/null +++ b/api/C_MountJournal.SetCollectedFilterSetting.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_MountJournal.SetCollectedFilterSetting() end \ No newline at end of file diff --git a/api/C_MountJournal.SetIsFavorite.lua b/api/C_MountJournal.SetIsFavorite.lua new file mode 100644 index 0000000..5f9cc6d --- /dev/null +++ b/api/C_MountJournal.SetIsFavorite.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_MountJournal.SetIsFavorite() end \ No newline at end of file diff --git a/api/C_MountJournal.Summon.lua b/api/C_MountJournal.Summon.lua new file mode 100644 index 0000000..bad3bfd --- /dev/null +++ b/api/C_MountJournal.Summon.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_MountJournal.Summon() end \ No newline at end of file diff --git a/api/C_NewItems.ClearAll.lua b/api/C_NewItems.ClearAll.lua new file mode 100644 index 0000000..e229106 --- /dev/null +++ b/api/C_NewItems.ClearAll.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_NewItems.ClearAll() end \ No newline at end of file diff --git a/api/C_PetBattles.AcceptPVPDuel.lua b/api/C_PetBattles.AcceptPVPDuel.lua new file mode 100644 index 0000000..1cccd3a --- /dev/null +++ b/api/C_PetBattles.AcceptPVPDuel.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.AcceptPVPDuel() end \ No newline at end of file diff --git a/api/C_PetBattles.AcceptQueuedPVPMatch.lua b/api/C_PetBattles.AcceptQueuedPVPMatch.lua new file mode 100644 index 0000000..3db6c60 --- /dev/null +++ b/api/C_PetBattles.AcceptQueuedPVPMatch.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Accepts a found Pet Battle Queue. +function C_PetBattles.AcceptQueuedPVPMatch() end \ No newline at end of file diff --git a/api/C_PetBattles.CanAcceptQueuedPVPMatch.lua b/api/C_PetBattles.CanAcceptQueuedPVPMatch.lua new file mode 100644 index 0000000..37a59af --- /dev/null +++ b/api/C_PetBattles.CanAcceptQueuedPVPMatch.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.CanAcceptQueuedPVPMatch() end \ No newline at end of file diff --git a/api/C_PetBattles.CanActivePetSwapOut.lua b/api/C_PetBattles.CanActivePetSwapOut.lua new file mode 100644 index 0000000..e0dac24 --- /dev/null +++ b/api/C_PetBattles.CanActivePetSwapOut.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.CanActivePetSwapOut() end \ No newline at end of file diff --git a/api/C_PetBattles.CanPetSwapIn.lua b/api/C_PetBattles.CanPetSwapIn.lua new file mode 100644 index 0000000..d364fef --- /dev/null +++ b/api/C_PetBattles.CanPetSwapIn.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.CanPetSwapIn() end \ No newline at end of file diff --git a/api/C_PetBattles.CancelPVPDuel.lua b/api/C_PetBattles.CancelPVPDuel.lua new file mode 100644 index 0000000..652149a --- /dev/null +++ b/api/C_PetBattles.CancelPVPDuel.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.CancelPVPDuel() end \ No newline at end of file diff --git a/api/C_PetBattles.ChangePet.lua b/api/C_PetBattles.ChangePet.lua new file mode 100644 index 0000000..55d151c --- /dev/null +++ b/api/C_PetBattles.ChangePet.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---Attempts to change your active pet. Has no effect if used when this switch isn't impossible (out of turn, with the ID of a dead pet, etc.). +function C_PetBattles.ChangePet(id) end \ No newline at end of file diff --git a/api/C_PetBattles.DeclineQueuedPVPMatch.lua b/api/C_PetBattles.DeclineQueuedPVPMatch.lua new file mode 100644 index 0000000..e6ca7f6 --- /dev/null +++ b/api/C_PetBattles.DeclineQueuedPVPMatch.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.DeclineQueuedPVPMatch() end \ No newline at end of file diff --git a/api/C_PetBattles.ForfeitGame.lua b/api/C_PetBattles.ForfeitGame.lua new file mode 100644 index 0000000..0cb8e1b --- /dev/null +++ b/api/C_PetBattles.ForfeitGame.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.ForfeitGame() end \ No newline at end of file diff --git a/api/C_PetBattles.GetAbilityEffectInfo.lua b/api/C_PetBattles.GetAbilityEffectInfo.lua new file mode 100644 index 0000000..649076f --- /dev/null +++ b/api/C_PetBattles.GetAbilityEffectInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.GetAbilityEffectInfo() end \ No newline at end of file diff --git a/api/C_PetBattles.GetAbilityInfo.lua b/api/C_PetBattles.GetAbilityInfo.lua new file mode 100644 index 0000000..7107aff --- /dev/null +++ b/api/C_PetBattles.GetAbilityInfo.lua @@ -0,0 +1,17 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param owner 2 +---@param 1 +---@param 2 +---@param slotnumber number +---@param spellIndex number +---@return number id +---@return string name +---@return string icon +---@return number maxcooldown +---@return string desc +---@return number numTurns +---@return number abilityPetType +---@return boolean nostrongweak +---Returns information on a battle pet's ability +function C_PetBattles.GetAbilityInfo(owner, 1, 2, slotnumber, spellIndex) end \ No newline at end of file diff --git a/api/C_PetBattles.GetAbilityInfoByID.lua b/api/C_PetBattles.GetAbilityInfoByID.lua new file mode 100644 index 0000000..9799bd6 --- /dev/null +++ b/api/C_PetBattles.GetAbilityInfoByID.lua @@ -0,0 +1,13 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@return nil +---@return string name +---@return string icon +---@return nil +---@return nil +---@return nil +---@return number? petType +---@return boolean nostrongweakhint +---Returns information about a pet battle ability based on the ID. +function C_PetBattles.GetAbilityInfoByID(id) end \ No newline at end of file diff --git a/api/C_PetBattles.GetAbilityProcTurnIndex.lua b/api/C_PetBattles.GetAbilityProcTurnIndex.lua new file mode 100644 index 0000000..2d47ae2 --- /dev/null +++ b/api/C_PetBattles.GetAbilityProcTurnIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.GetAbilityProcTurnIndex() end \ No newline at end of file diff --git a/api/C_PetBattles.GetAbilityState.lua b/api/C_PetBattles.GetAbilityState.lua new file mode 100644 index 0000000..891668a --- /dev/null +++ b/api/C_PetBattles.GetAbilityState.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param owner 2 +---@param 1 +---@param 2 +---@param slotnumber number +---@param spellIndex number +---@return boolean isUsable +---@return number currentCooldown +---Returns the cooldown state of a pet ability +function C_PetBattles.GetAbilityState(owner, 1, 2, slotnumber, spellIndex) end \ No newline at end of file diff --git a/api/C_PetBattles.GetAbilityStateModification.lua b/api/C_PetBattles.GetAbilityStateModification.lua new file mode 100644 index 0000000..bcec60c --- /dev/null +++ b/api/C_PetBattles.GetAbilityStateModification.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.GetAbilityStateModification() end \ No newline at end of file diff --git a/api/C_PetBattles.GetActivePet.lua b/api/C_PetBattles.GetActivePet.lua new file mode 100644 index 0000000..96c6639 --- /dev/null +++ b/api/C_PetBattles.GetActivePet.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param owner 2 +---@param 1 +---@param 2 +---@return number index +---Returns the index of the currently active pet. +function C_PetBattles.GetActivePet(owner, 1, 2) end \ No newline at end of file diff --git a/api/C_PetBattles.GetAllEffectNames.lua b/api/C_PetBattles.GetAllEffectNames.lua new file mode 100644 index 0000000..f4c7cc5 --- /dev/null +++ b/api/C_PetBattles.GetAllEffectNames.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.GetAllEffectNames() end \ No newline at end of file diff --git a/api/C_PetBattles.GetAllStates.lua b/api/C_PetBattles.GetAllStates.lua new file mode 100644 index 0000000..9340afb --- /dev/null +++ b/api/C_PetBattles.GetAllStates.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.GetAllStates() end \ No newline at end of file diff --git a/api/C_PetBattles.GetAttackModifier.lua b/api/C_PetBattles.GetAttackModifier.lua new file mode 100644 index 0000000..c3a8d39 --- /dev/null +++ b/api/C_PetBattles.GetAttackModifier.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param YourType number? +---@param EnemyType number? +---Returns the modification to attacks based on types. +function C_PetBattles.GetAttackModifier(YourType, EnemyType) end \ No newline at end of file diff --git a/api/C_PetBattles.GetAuraInfo.lua b/api/C_PetBattles.GetAuraInfo.lua new file mode 100644 index 0000000..bddaa02 --- /dev/null +++ b/api/C_PetBattles.GetAuraInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.GetAuraInfo() end \ No newline at end of file diff --git a/api/C_PetBattles.GetBattleState.lua b/api/C_PetBattles.GetBattleState.lua new file mode 100644 index 0000000..191521c --- /dev/null +++ b/api/C_PetBattles.GetBattleState.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 7 battleState +---@return 2 +---@return 3 +---@return 4 +---@return 7 +---Returns the current battle state. +function C_PetBattles.GetBattleState() end \ No newline at end of file diff --git a/api/C_PetBattles.GetBreedQuality.lua b/api/C_PetBattles.GetBreedQuality.lua new file mode 100644 index 0000000..154d3ce --- /dev/null +++ b/api/C_PetBattles.GetBreedQuality.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param petOwner number +---@param petIndex number +---@return number quality +---Returns the breed quality of a pet. +function C_PetBattles.GetBreedQuality(petOwner, petIndex) end \ No newline at end of file diff --git a/api/C_PetBattles.GetDisplayID.lua b/api/C_PetBattles.GetDisplayID.lua new file mode 100644 index 0000000..be61465 --- /dev/null +++ b/api/C_PetBattles.GetDisplayID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.GetDisplayID() end \ No newline at end of file diff --git a/api/C_PetBattles.GetForfeitPenalty.lua b/api/C_PetBattles.GetForfeitPenalty.lua new file mode 100644 index 0000000..0402c2b --- /dev/null +++ b/api/C_PetBattles.GetForfeitPenalty.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.GetForfeitPenalty() end \ No newline at end of file diff --git a/api/C_PetBattles.GetHealth.lua b/api/C_PetBattles.GetHealth.lua new file mode 100644 index 0000000..2626cff --- /dev/null +++ b/api/C_PetBattles.GetHealth.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param petOwner number +---@param petIndex number +---@return number health +---Returns the current health of a specific pet in the current pet battle. +function C_PetBattles.GetHealth(petOwner, petIndex) end \ No newline at end of file diff --git a/api/C_PetBattles.GetIcon.lua b/api/C_PetBattles.GetIcon.lua new file mode 100644 index 0000000..b42554d --- /dev/null +++ b/api/C_PetBattles.GetIcon.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param owner 2 +---@param 1 +---@param 2 +---@param index number +---@return string icon +---Returns the path of a pet's icon texture. +function C_PetBattles.GetIcon(owner, 1, 2, index) end \ No newline at end of file diff --git a/api/C_PetBattles.GetLevel.lua b/api/C_PetBattles.GetLevel.lua new file mode 100644 index 0000000..90bcf32 --- /dev/null +++ b/api/C_PetBattles.GetLevel.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param petOwner number +---@param petIndex number +---@return number level +---Returns the level of a pet +function C_PetBattles.GetLevel(petOwner, petIndex) end \ No newline at end of file diff --git a/api/C_PetBattles.GetMaxHealth.lua b/api/C_PetBattles.GetMaxHealth.lua new file mode 100644 index 0000000..3335cc2 --- /dev/null +++ b/api/C_PetBattles.GetMaxHealth.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param petOwner number +---@param petIndex number +---@return number maxHealth +---Returns the maximum health of a specific pet in the current pet battle. +function C_PetBattles.GetMaxHealth(petOwner, petIndex) end \ No newline at end of file diff --git a/api/C_PetBattles.GetName.lua b/api/C_PetBattles.GetName.lua new file mode 100644 index 0000000..936d46c --- /dev/null +++ b/api/C_PetBattles.GetName.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param owner number? +---@param index number +---@return string name +---@return string default +---Returns the name of a pet +function C_PetBattles.GetName(owner, index) end \ No newline at end of file diff --git a/api/C_PetBattles.GetNumAuras.lua b/api/C_PetBattles.GetNumAuras.lua new file mode 100644 index 0000000..c92d95a --- /dev/null +++ b/api/C_PetBattles.GetNumAuras.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param owner string? +---@param index number +---@return number auras +---Returns the number of auras on a pet +function C_PetBattles.GetNumAuras(owner, index) end \ No newline at end of file diff --git a/api/C_PetBattles.GetNumPets.lua b/api/C_PetBattles.GetNumPets.lua new file mode 100644 index 0000000..6dfd856 --- /dev/null +++ b/api/C_PetBattles.GetNumPets.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param owner 2 +---@param 1 +---@param 2 +---@return number amount +---Returns the number of pets a player/enemy has. +function C_PetBattles.GetNumPets(owner, 1, 2) end \ No newline at end of file diff --git a/api/C_PetBattles.GetPVPMatchmakingInfo.lua b/api/C_PetBattles.GetPVPMatchmakingInfo.lua new file mode 100644 index 0000000..39ce4b9 --- /dev/null +++ b/api/C_PetBattles.GetPVPMatchmakingInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.GetPVPMatchmakingInfo() end \ No newline at end of file diff --git a/api/C_PetBattles.GetPetSpeciesID.lua b/api/C_PetBattles.GetPetSpeciesID.lua new file mode 100644 index 0000000..50e412e --- /dev/null +++ b/api/C_PetBattles.GetPetSpeciesID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.GetPetSpeciesID() end \ No newline at end of file diff --git a/api/C_PetBattles.GetPetType.lua b/api/C_PetBattles.GetPetType.lua new file mode 100644 index 0000000..c6bb654 --- /dev/null +++ b/api/C_PetBattles.GetPetType.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.GetPetType() end \ No newline at end of file diff --git a/api/C_PetBattles.GetPlayerTrapAbility.lua b/api/C_PetBattles.GetPlayerTrapAbility.lua new file mode 100644 index 0000000..39dfcba --- /dev/null +++ b/api/C_PetBattles.GetPlayerTrapAbility.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.GetPlayerTrapAbility() end \ No newline at end of file diff --git a/api/C_PetBattles.GetPower.lua b/api/C_PetBattles.GetPower.lua new file mode 100644 index 0000000..b49c528 --- /dev/null +++ b/api/C_PetBattles.GetPower.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param owner number +---@param index number +---Returns the power of a pet. +function C_PetBattles.GetPower(owner, index) end \ No newline at end of file diff --git a/api/C_PetBattles.GetSelectedAction.lua b/api/C_PetBattles.GetSelectedAction.lua new file mode 100644 index 0000000..7ba3964 --- /dev/null +++ b/api/C_PetBattles.GetSelectedAction.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.GetSelectedAction() end \ No newline at end of file diff --git a/api/C_PetBattles.GetSpeed.lua b/api/C_PetBattles.GetSpeed.lua new file mode 100644 index 0000000..0441b6a --- /dev/null +++ b/api/C_PetBattles.GetSpeed.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param owner 2 +---@param 1 +---@param 2 +---@param index number +---@return number speed +---Returns the speed of a pet. +function C_PetBattles.GetSpeed(owner, 1, 2, index) end \ No newline at end of file diff --git a/api/C_PetBattles.GetStateValue.lua b/api/C_PetBattles.GetStateValue.lua new file mode 100644 index 0000000..dd43707 --- /dev/null +++ b/api/C_PetBattles.GetStateValue.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.GetStateValue() end \ No newline at end of file diff --git a/api/C_PetBattles.GetTurnTimeInfo.lua b/api/C_PetBattles.GetTurnTimeInfo.lua new file mode 100644 index 0000000..6674cee --- /dev/null +++ b/api/C_PetBattles.GetTurnTimeInfo.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number timeRemaining +---@return number totalTime +---Returns the remaining time and max time for waiting on a turn +function C_PetBattles.GetTurnTimeInfo() end \ No newline at end of file diff --git a/api/C_PetBattles.GetXP.lua b/api/C_PetBattles.GetXP.lua new file mode 100644 index 0000000..66b1eb2 --- /dev/null +++ b/api/C_PetBattles.GetXP.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param owner string? +---@param index number +---@return number xp +---@return number maxXP +---Returns the current and maximum experience of a pet +function C_PetBattles.GetXP(owner, index) end \ No newline at end of file diff --git a/api/C_PetBattles.IsInBattle.lua b/api/C_PetBattles.IsInBattle.lua new file mode 100644 index 0000000..cffee80 --- /dev/null +++ b/api/C_PetBattles.IsInBattle.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Returns true during a pet battle +function C_PetBattles.IsInBattle() end \ No newline at end of file diff --git a/api/C_PetBattles.IsPlayerNPC.lua b/api/C_PetBattles.IsPlayerNPC.lua new file mode 100644 index 0000000..87f8793 --- /dev/null +++ b/api/C_PetBattles.IsPlayerNPC.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param player string? +---@return boolean isnpc +---Returns whether a participant in a pet battle is a player or an NPC +function C_PetBattles.IsPlayerNPC(player) end \ No newline at end of file diff --git a/api/C_PetBattles.IsSkipAvailable.lua b/api/C_PetBattles.IsSkipAvailable.lua new file mode 100644 index 0000000..e835e43 --- /dev/null +++ b/api/C_PetBattles.IsSkipAvailable.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.IsSkipAvailable() end \ No newline at end of file diff --git a/api/C_PetBattles.IsTrapAvailable.lua b/api/C_PetBattles.IsTrapAvailable.lua new file mode 100644 index 0000000..93c886a --- /dev/null +++ b/api/C_PetBattles.IsTrapAvailable.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.IsTrapAvailable() end \ No newline at end of file diff --git a/api/C_PetBattles.IsWaitingOnOpponent.lua b/api/C_PetBattles.IsWaitingOnOpponent.lua new file mode 100644 index 0000000..5576fc8 --- /dev/null +++ b/api/C_PetBattles.IsWaitingOnOpponent.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean waiting +---Returns whether or not you are waiting on the opponent +function C_PetBattles.IsWaitingOnOpponent() end \ No newline at end of file diff --git a/api/C_PetBattles.IsWildBattle.lua b/api/C_PetBattles.IsWildBattle.lua new file mode 100644 index 0000000..c0f28c8 --- /dev/null +++ b/api/C_PetBattles.IsWildBattle.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean isWild +---Returns whether or not in wild battle.. Returns true if the pet battle is against a wild pet. +function C_PetBattles.IsWildBattle() end \ No newline at end of file diff --git a/api/C_PetBattles.SetPendingReportBattlePetTarget.lua b/api/C_PetBattles.SetPendingReportBattlePetTarget.lua new file mode 100644 index 0000000..fc6672c --- /dev/null +++ b/api/C_PetBattles.SetPendingReportBattlePetTarget.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.SetPendingReportBattlePetTarget() end \ No newline at end of file diff --git a/api/C_PetBattles.SetPendingReportTargetFromUnit.lua b/api/C_PetBattles.SetPendingReportTargetFromUnit.lua new file mode 100644 index 0000000..a167ac2 --- /dev/null +++ b/api/C_PetBattles.SetPendingReportTargetFromUnit.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.SetPendingReportTargetFromUnit() end \ No newline at end of file diff --git a/api/C_PetBattles.ShouldShowPetSelect.lua b/api/C_PetBattles.ShouldShowPetSelect.lua new file mode 100644 index 0000000..2b8a12e --- /dev/null +++ b/api/C_PetBattles.ShouldShowPetSelect.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.ShouldShowPetSelect() end \ No newline at end of file diff --git a/api/C_PetBattles.SkipTurn.lua b/api/C_PetBattles.SkipTurn.lua new file mode 100644 index 0000000..f51f4c8 --- /dev/null +++ b/api/C_PetBattles.SkipTurn.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Does a pass on your turn for a round. +function C_PetBattles.SkipTurn() end \ No newline at end of file diff --git a/api/C_PetBattles.StartPVPDuel.lua b/api/C_PetBattles.StartPVPDuel.lua new file mode 100644 index 0000000..3f55f42 --- /dev/null +++ b/api/C_PetBattles.StartPVPDuel.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.StartPVPDuel() end \ No newline at end of file diff --git a/api/C_PetBattles.StartPVPMatchmaking.lua b/api/C_PetBattles.StartPVPMatchmaking.lua new file mode 100644 index 0000000..67d5732 --- /dev/null +++ b/api/C_PetBattles.StartPVPMatchmaking.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.StartPVPMatchmaking() end \ No newline at end of file diff --git a/api/C_PetBattles.StopPVPMatchmaking.lua b/api/C_PetBattles.StopPVPMatchmaking.lua new file mode 100644 index 0000000..96da6ac --- /dev/null +++ b/api/C_PetBattles.StopPVPMatchmaking.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetBattles.StopPVPMatchmaking() end \ No newline at end of file diff --git a/api/C_PetBattles.UseAbility.lua b/api/C_PetBattles.UseAbility.lua new file mode 100644 index 0000000..d44afee --- /dev/null +++ b/api/C_PetBattles.UseAbility.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---Uses an ability. +function C_PetBattles.UseAbility(id) end \ No newline at end of file diff --git a/api/C_PetBattles.UseTrap.lua b/api/C_PetBattles.UseTrap.lua new file mode 100644 index 0000000..c90aa67 --- /dev/null +++ b/api/C_PetBattles.UseTrap.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Throws the trap if the target pet has low enough health. Always uses best trap. +function C_PetBattles.UseTrap() end \ No newline at end of file diff --git a/api/C_PetJournal.AddAllPetSourcesFilter.lua b/api/C_PetJournal.AddAllPetSourcesFilter.lua new file mode 100644 index 0000000..0da3be5 --- /dev/null +++ b/api/C_PetJournal.AddAllPetSourcesFilter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.AddAllPetSourcesFilter() end \ No newline at end of file diff --git a/api/C_PetJournal.AddAllPetTypesFilter.lua b/api/C_PetJournal.AddAllPetTypesFilter.lua new file mode 100644 index 0000000..bc494d0 --- /dev/null +++ b/api/C_PetJournal.AddAllPetTypesFilter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.AddAllPetTypesFilter() end \ No newline at end of file diff --git a/api/C_PetJournal.CagePetByID.lua b/api/C_PetJournal.CagePetByID.lua new file mode 100644 index 0000000..e51ae82 --- /dev/null +++ b/api/C_PetJournal.CagePetByID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.CagePetByID() end \ No newline at end of file diff --git a/api/C_PetJournal.ClearAllPetSourcesFilter.lua b/api/C_PetJournal.ClearAllPetSourcesFilter.lua new file mode 100644 index 0000000..486c6e5 --- /dev/null +++ b/api/C_PetJournal.ClearAllPetSourcesFilter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.ClearAllPetSourcesFilter() end \ No newline at end of file diff --git a/api/C_PetJournal.ClearAllPetTypesFilter.lua b/api/C_PetJournal.ClearAllPetTypesFilter.lua new file mode 100644 index 0000000..c82c980 --- /dev/null +++ b/api/C_PetJournal.ClearAllPetTypesFilter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.ClearAllPetTypesFilter() end \ No newline at end of file diff --git a/api/C_PetJournal.ClearSearchFilter.lua b/api/C_PetJournal.ClearSearchFilter.lua new file mode 100644 index 0000000..cb84deb --- /dev/null +++ b/api/C_PetJournal.ClearSearchFilter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.ClearSearchFilter() end \ No newline at end of file diff --git a/api/C_PetJournal.FindPetIDByName.lua b/api/C_PetJournal.FindPetIDByName.lua new file mode 100644 index 0000000..8ca9845 --- /dev/null +++ b/api/C_PetJournal.FindPetIDByName.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.FindPetIDByName() end \ No newline at end of file diff --git a/api/C_PetJournal.GetBattlePetLink.lua b/api/C_PetJournal.GetBattlePetLink.lua new file mode 100644 index 0000000..4415720 --- /dev/null +++ b/api/C_PetJournal.GetBattlePetLink.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.GetBattlePetLink() end \ No newline at end of file diff --git a/api/C_PetJournal.GetNumCollectedInfo.lua b/api/C_PetJournal.GetNumCollectedInfo.lua new file mode 100644 index 0000000..6980335 --- /dev/null +++ b/api/C_PetJournal.GetNumCollectedInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Returns the number of pets for that species. Returns the number of pets for that species ID +function C_PetJournal.GetNumCollectedInfo() end \ No newline at end of file diff --git a/api/C_PetJournal.GetNumPetSources.lua b/api/C_PetJournal.GetNumPetSources.lua new file mode 100644 index 0000000..bfa73ba --- /dev/null +++ b/api/C_PetJournal.GetNumPetSources.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.GetNumPetSources() end \ No newline at end of file diff --git a/api/C_PetJournal.GetNumPetTypes.lua b/api/C_PetJournal.GetNumPetTypes.lua new file mode 100644 index 0000000..9d3471b --- /dev/null +++ b/api/C_PetJournal.GetNumPetTypes.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.GetNumPetTypes() end \ No newline at end of file diff --git a/api/C_PetJournal.GetNumPets.lua b/api/C_PetJournal.GetNumPets.lua new file mode 100644 index 0000000..5dd1945 --- /dev/null +++ b/api/C_PetJournal.GetNumPets.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Returns two integers, filtered count, and total count. Returns how many pets currently match user filter, and the grand total collected by the user. +function C_PetJournal.GetNumPets() end \ No newline at end of file diff --git a/api/C_PetJournal.GetOwnedBattlePetString.lua b/api/C_PetJournal.GetOwnedBattlePetString.lua new file mode 100644 index 0000000..42af4ad --- /dev/null +++ b/api/C_PetJournal.GetOwnedBattlePetString.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.GetOwnedBattlePetString() end \ No newline at end of file diff --git a/api/C_PetJournal.GetPetAbilityInfo.lua b/api/C_PetJournal.GetPetAbilityInfo.lua new file mode 100644 index 0000000..acf5c5e --- /dev/null +++ b/api/C_PetJournal.GetPetAbilityInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.GetPetAbilityInfo() end \ No newline at end of file diff --git a/api/C_PetJournal.GetPetAbilityList.lua b/api/C_PetJournal.GetPetAbilityList.lua new file mode 100644 index 0000000..43b433c --- /dev/null +++ b/api/C_PetJournal.GetPetAbilityList.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.GetPetAbilityList() end \ No newline at end of file diff --git a/api/C_PetJournal.GetPetCooldownByGUID.lua b/api/C_PetJournal.GetPetCooldownByGUID.lua new file mode 100644 index 0000000..8953362 --- /dev/null +++ b/api/C_PetJournal.GetPetCooldownByGUID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.GetPetCooldownByGUID() end \ No newline at end of file diff --git a/api/C_PetJournal.GetPetInfoByIndex.lua b/api/C_PetJournal.GetPetInfoByIndex.lua new file mode 100644 index 0000000..729c32a --- /dev/null +++ b/api/C_PetJournal.GetPetInfoByIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.GetPetInfoByIndex() end \ No newline at end of file diff --git a/api/C_PetJournal.GetPetInfoByPetID.lua b/api/C_PetJournal.GetPetInfoByPetID.lua new file mode 100644 index 0000000..922e619 --- /dev/null +++ b/api/C_PetJournal.GetPetInfoByPetID.lua @@ -0,0 +1,37 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param petID string +---@return number speciesID +---@return nil customName +---@return name +---@return nil +---@return number level +---@return number xp +---@return number maxXp +---@return number displayID +---@return boolean isFavorite +---@return Squirrel petName +---@return Lil' KT +---@return Squirrel +---@return string petIcon +---@return 10 petType +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---@return 5 +---@return 6 +---@return 7 +---@return 8 +---@return 9 +---@return 10 +---@return number creatureID +---@return example sourceText +---@return example +---@return string description +---@return boolean isWild +---@return boolean canBattle +---@return boolean tradable +---@return boolean unique +---Retreives information about a battle pet from its GUID +function C_PetJournal.GetPetInfoByPetID(petID) end \ No newline at end of file diff --git a/api/C_PetJournal.GetPetInfoBySpeciesID.lua b/api/C_PetJournal.GetPetInfoBySpeciesID.lua new file mode 100644 index 0000000..e6ea904 --- /dev/null +++ b/api/C_PetJournal.GetPetInfoBySpeciesID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.GetPetInfoBySpeciesID() end \ No newline at end of file diff --git a/api/C_PetJournal.GetPetLoadOutInfo.lua b/api/C_PetJournal.GetPetLoadOutInfo.lua new file mode 100644 index 0000000..8749e0d --- /dev/null +++ b/api/C_PetJournal.GetPetLoadOutInfo.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slotIndex number +---@return string petID +---@return number petSpellID_slot1 +---@return number petSpellID_slot2 +---@return number petSpellID_slot3 +---@return boolean locked +---Returns pet and spell IDs +function C_PetJournal.GetPetLoadOutInfo(slotIndex) end \ No newline at end of file diff --git a/api/C_PetJournal.GetPetSortParameter.lua b/api/C_PetJournal.GetPetSortParameter.lua new file mode 100644 index 0000000..b69c513 --- /dev/null +++ b/api/C_PetJournal.GetPetSortParameter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.GetPetSortParameter() end \ No newline at end of file diff --git a/api/C_PetJournal.GetPetStats.lua b/api/C_PetJournal.GetPetStats.lua new file mode 100644 index 0000000..2feb7cf --- /dev/null +++ b/api/C_PetJournal.GetPetStats.lua @@ -0,0 +1,16 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param petID string +---@return number health +---@return number maxHealth +---@return number attack +---@return number speed +---@return 6 rarity +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---@return 5 +---@return 6 +---Retrieves the stats of a battle pet from its GUID +function C_PetJournal.GetPetStats(petID) end \ No newline at end of file diff --git a/api/C_PetJournal.GetPetTeamAverageLevel.lua b/api/C_PetJournal.GetPetTeamAverageLevel.lua new file mode 100644 index 0000000..a3ec9be --- /dev/null +++ b/api/C_PetJournal.GetPetTeamAverageLevel.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.GetPetTeamAverageLevel() end \ No newline at end of file diff --git a/api/C_PetJournal.GetSummonedPetGUID.lua b/api/C_PetJournal.GetSummonedPetGUID.lua new file mode 100644 index 0000000..5bead4f --- /dev/null +++ b/api/C_PetJournal.GetSummonedPetGUID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.GetSummonedPetGUID() end \ No newline at end of file diff --git a/api/C_PetJournal.IsFindBattleEnabled.lua b/api/C_PetJournal.IsFindBattleEnabled.lua new file mode 100644 index 0000000..f918a49 --- /dev/null +++ b/api/C_PetJournal.IsFindBattleEnabled.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.IsFindBattleEnabled() end \ No newline at end of file diff --git a/api/C_PetJournal.IsFlagFiltered.lua b/api/C_PetJournal.IsFlagFiltered.lua new file mode 100644 index 0000000..25d74f4 --- /dev/null +++ b/api/C_PetJournal.IsFlagFiltered.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.IsFlagFiltered() end \ No newline at end of file diff --git a/api/C_PetJournal.IsJournalReadOnly.lua b/api/C_PetJournal.IsJournalReadOnly.lua new file mode 100644 index 0000000..0e50d83 --- /dev/null +++ b/api/C_PetJournal.IsJournalReadOnly.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.IsJournalReadOnly() end \ No newline at end of file diff --git a/api/C_PetJournal.IsJournalUnlocked.lua b/api/C_PetJournal.IsJournalUnlocked.lua new file mode 100644 index 0000000..e97df49 --- /dev/null +++ b/api/C_PetJournal.IsJournalUnlocked.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.IsJournalUnlocked() end \ No newline at end of file diff --git a/api/C_PetJournal.IsPetSourceFiltered.lua b/api/C_PetJournal.IsPetSourceFiltered.lua new file mode 100644 index 0000000..40455e0 --- /dev/null +++ b/api/C_PetJournal.IsPetSourceFiltered.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.IsPetSourceFiltered() end \ No newline at end of file diff --git a/api/C_PetJournal.IsPetTypeFiltered.lua b/api/C_PetJournal.IsPetTypeFiltered.lua new file mode 100644 index 0000000..13436b9 --- /dev/null +++ b/api/C_PetJournal.IsPetTypeFiltered.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.IsPetTypeFiltered() end \ No newline at end of file diff --git a/api/C_PetJournal.PetCanBeReleased.lua b/api/C_PetJournal.PetCanBeReleased.lua new file mode 100644 index 0000000..e3d1784 --- /dev/null +++ b/api/C_PetJournal.PetCanBeReleased.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.PetCanBeReleased() end \ No newline at end of file diff --git a/api/C_PetJournal.PetIsCapturable.lua b/api/C_PetJournal.PetIsCapturable.lua new file mode 100644 index 0000000..65d4c83 --- /dev/null +++ b/api/C_PetJournal.PetIsCapturable.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.PetIsCapturable() end \ No newline at end of file diff --git a/api/C_PetJournal.PetIsFavorite.lua b/api/C_PetJournal.PetIsFavorite.lua new file mode 100644 index 0000000..ab37b27 --- /dev/null +++ b/api/C_PetJournal.PetIsFavorite.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.PetIsFavorite() end \ No newline at end of file diff --git a/api/C_PetJournal.PetIsHurt.lua b/api/C_PetJournal.PetIsHurt.lua new file mode 100644 index 0000000..03cca4a --- /dev/null +++ b/api/C_PetJournal.PetIsHurt.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.PetIsHurt() end \ No newline at end of file diff --git a/api/C_PetJournal.PetIsLockedForConvert.lua b/api/C_PetJournal.PetIsLockedForConvert.lua new file mode 100644 index 0000000..ad67e2c --- /dev/null +++ b/api/C_PetJournal.PetIsLockedForConvert.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.PetIsLockedForConvert() end \ No newline at end of file diff --git a/api/C_PetJournal.PetIsRevoked.lua b/api/C_PetJournal.PetIsRevoked.lua new file mode 100644 index 0000000..7751fe3 --- /dev/null +++ b/api/C_PetJournal.PetIsRevoked.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.PetIsRevoked() end \ No newline at end of file diff --git a/api/C_PetJournal.PetIsSlotted.lua b/api/C_PetJournal.PetIsSlotted.lua new file mode 100644 index 0000000..47e79ad --- /dev/null +++ b/api/C_PetJournal.PetIsSlotted.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.PetIsSlotted() end \ No newline at end of file diff --git a/api/C_PetJournal.PetIsSummonable.lua b/api/C_PetJournal.PetIsSummonable.lua new file mode 100644 index 0000000..8b378e3 --- /dev/null +++ b/api/C_PetJournal.PetIsSummonable.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.PetIsSummonable() end \ No newline at end of file diff --git a/api/C_PetJournal.PetIsTradable.lua b/api/C_PetJournal.PetIsTradable.lua new file mode 100644 index 0000000..e1303b3 --- /dev/null +++ b/api/C_PetJournal.PetIsTradable.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.PetIsTradable() end \ No newline at end of file diff --git a/api/C_PetJournal.PickupPet.lua b/api/C_PetJournal.PickupPet.lua new file mode 100644 index 0000000..c2c7b9b --- /dev/null +++ b/api/C_PetJournal.PickupPet.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.PickupPet() end \ No newline at end of file diff --git a/api/C_PetJournal.ReleasePetByID.lua b/api/C_PetJournal.ReleasePetByID.lua new file mode 100644 index 0000000..9f3d961 --- /dev/null +++ b/api/C_PetJournal.ReleasePetByID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.ReleasePetByID() end \ No newline at end of file diff --git a/api/C_PetJournal.SetAbility.lua b/api/C_PetJournal.SetAbility.lua new file mode 100644 index 0000000..6b4dad2 --- /dev/null +++ b/api/C_PetJournal.SetAbility.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slotIndex number +---@param spellIndex number +---@param petSpellID number +---Set battle pet ability +function C_PetJournal.SetAbility(slotIndex, spellIndex, petSpellID) end \ No newline at end of file diff --git a/api/C_PetJournal.SetCustomName.lua b/api/C_PetJournal.SetCustomName.lua new file mode 100644 index 0000000..e634902 --- /dev/null +++ b/api/C_PetJournal.SetCustomName.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.SetCustomName() end \ No newline at end of file diff --git a/api/C_PetJournal.SetFavorite.lua b/api/C_PetJournal.SetFavorite.lua new file mode 100644 index 0000000..55df893 --- /dev/null +++ b/api/C_PetJournal.SetFavorite.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.SetFavorite() end \ No newline at end of file diff --git a/api/C_PetJournal.SetFlagFilter.lua b/api/C_PetJournal.SetFlagFilter.lua new file mode 100644 index 0000000..9cf0b30 --- /dev/null +++ b/api/C_PetJournal.SetFlagFilter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.SetFlagFilter() end \ No newline at end of file diff --git a/api/C_PetJournal.SetPetLoadOutInfo.lua b/api/C_PetJournal.SetPetLoadOutInfo.lua new file mode 100644 index 0000000..3b72487 --- /dev/null +++ b/api/C_PetJournal.SetPetLoadOutInfo.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slotIndex number +---@param petID string +---Setup battle pet team +function C_PetJournal.SetPetLoadOutInfo(slotIndex, petID) end \ No newline at end of file diff --git a/api/C_PetJournal.SetPetSortParameter.lua b/api/C_PetJournal.SetPetSortParameter.lua new file mode 100644 index 0000000..f3395fb --- /dev/null +++ b/api/C_PetJournal.SetPetSortParameter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.SetPetSortParameter() end \ No newline at end of file diff --git a/api/C_PetJournal.SetPetSourceFilter.lua b/api/C_PetJournal.SetPetSourceFilter.lua new file mode 100644 index 0000000..effd717 --- /dev/null +++ b/api/C_PetJournal.SetPetSourceFilter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.SetPetSourceFilter() end \ No newline at end of file diff --git a/api/C_PetJournal.SetPetTypeFilter.lua b/api/C_PetJournal.SetPetTypeFilter.lua new file mode 100644 index 0000000..13ee909 --- /dev/null +++ b/api/C_PetJournal.SetPetTypeFilter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.SetPetTypeFilter() end \ No newline at end of file diff --git a/api/C_PetJournal.SetSearchFilter.lua b/api/C_PetJournal.SetSearchFilter.lua new file mode 100644 index 0000000..a986e4c --- /dev/null +++ b/api/C_PetJournal.SetSearchFilter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.SetSearchFilter() end \ No newline at end of file diff --git a/api/C_PetJournal.SummonPetByGUID.lua b/api/C_PetJournal.SummonPetByGUID.lua new file mode 100644 index 0000000..cc604c4 --- /dev/null +++ b/api/C_PetJournal.SummonPetByGUID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.SummonPetByGUID() end \ No newline at end of file diff --git a/api/C_PetJournal.SummonRandomPet.lua b/api/C_PetJournal.SummonRandomPet.lua new file mode 100644 index 0000000..96f938b --- /dev/null +++ b/api/C_PetJournal.SummonRandomPet.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_PetJournal.SummonRandomPet() end \ No newline at end of file diff --git a/api/C_Questline.GetNumAvailableQuestlines.lua b/api/C_Questline.GetNumAvailableQuestlines.lua new file mode 100644 index 0000000..84d9fe1 --- /dev/null +++ b/api/C_Questline.GetNumAvailableQuestlines.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Questline.GetNumAvailableQuestlines() end \ No newline at end of file diff --git a/api/C_Questline.GetQuestlineInfoByIndex.lua b/api/C_Questline.GetQuestlineInfoByIndex.lua new file mode 100644 index 0000000..f8bb210 --- /dev/null +++ b/api/C_Questline.GetQuestlineInfoByIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Questline.GetQuestlineInfoByIndex() end \ No newline at end of file diff --git a/api/C_RecruitAFriend.CheckEmailEnabled.lua b/api/C_RecruitAFriend.CheckEmailEnabled.lua new file mode 100644 index 0000000..b0317d5 --- /dev/null +++ b/api/C_RecruitAFriend.CheckEmailEnabled.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_RecruitAFriend.CheckEmailEnabled() end \ No newline at end of file diff --git a/api/C_RecruitAFriend.GetRecruitInfo.lua b/api/C_RecruitAFriend.GetRecruitInfo.lua new file mode 100644 index 0000000..8ca540e --- /dev/null +++ b/api/C_RecruitAFriend.GetRecruitInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_RecruitAFriend.GetRecruitInfo() end \ No newline at end of file diff --git a/api/C_RecruitAFriend.IsSendingEnabled.lua b/api/C_RecruitAFriend.IsSendingEnabled.lua new file mode 100644 index 0000000..63abc49 --- /dev/null +++ b/api/C_RecruitAFriend.IsSendingEnabled.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_RecruitAFriend.IsSendingEnabled() end \ No newline at end of file diff --git a/api/C_RecruitAFriend.SendRecruit.lua b/api/C_RecruitAFriend.SendRecruit.lua new file mode 100644 index 0000000..68b0d76 --- /dev/null +++ b/api/C_RecruitAFriend.SendRecruit.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_RecruitAFriend.SendRecruit() end \ No newline at end of file diff --git a/api/C_Scenario.GetBonusStepRewardQuestID.lua b/api/C_Scenario.GetBonusStepRewardQuestID.lua new file mode 100644 index 0000000..e82adc9 --- /dev/null +++ b/api/C_Scenario.GetBonusStepRewardQuestID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Scenario.GetBonusStepRewardQuestID() end \ No newline at end of file diff --git a/api/C_Scenario.GetBonusSteps.lua b/api/C_Scenario.GetBonusSteps.lua new file mode 100644 index 0000000..56f7f1e --- /dev/null +++ b/api/C_Scenario.GetBonusSteps.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Scenario.GetBonusSteps() end \ No newline at end of file diff --git a/api/C_Scenario.GetCriteriaInfo.lua b/api/C_Scenario.GetCriteriaInfo.lua new file mode 100644 index 0000000..476b384 --- /dev/null +++ b/api/C_Scenario.GetCriteriaInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Scenario.GetCriteriaInfo() end \ No newline at end of file diff --git a/api/C_Scenario.GetCriteriaInfoByStep.lua b/api/C_Scenario.GetCriteriaInfoByStep.lua new file mode 100644 index 0000000..cdc90d2 --- /dev/null +++ b/api/C_Scenario.GetCriteriaInfoByStep.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Scenario.GetCriteriaInfoByStep() end \ No newline at end of file diff --git a/api/C_Scenario.GetInfo.lua b/api/C_Scenario.GetInfo.lua new file mode 100644 index 0000000..4f4b30c --- /dev/null +++ b/api/C_Scenario.GetInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Scenario.GetInfo() end \ No newline at end of file diff --git a/api/C_Scenario.GetProvingGroundsInfo.lua b/api/C_Scenario.GetProvingGroundsInfo.lua new file mode 100644 index 0000000..23ae10d --- /dev/null +++ b/api/C_Scenario.GetProvingGroundsInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Scenario.GetProvingGroundsInfo() end \ No newline at end of file diff --git a/api/C_Scenario.GetScenarioIconInfo.lua b/api/C_Scenario.GetScenarioIconInfo.lua new file mode 100644 index 0000000..28d3b93 --- /dev/null +++ b/api/C_Scenario.GetScenarioIconInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Scenario.GetScenarioIconInfo() end \ No newline at end of file diff --git a/api/C_Scenario.GetStepInfo.lua b/api/C_Scenario.GetStepInfo.lua new file mode 100644 index 0000000..0bf4402 --- /dev/null +++ b/api/C_Scenario.GetStepInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Scenario.GetStepInfo() end \ No newline at end of file diff --git a/api/C_Scenario.GetSupersededObjectives.lua b/api/C_Scenario.GetSupersededObjectives.lua new file mode 100644 index 0000000..7df60fd --- /dev/null +++ b/api/C_Scenario.GetSupersededObjectives.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Scenario.GetSupersededObjectives() end \ No newline at end of file diff --git a/api/C_Scenario.IsChallengeMode.lua b/api/C_Scenario.IsChallengeMode.lua new file mode 100644 index 0000000..1bb3693 --- /dev/null +++ b/api/C_Scenario.IsChallengeMode.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Scenario.IsChallengeMode() end \ No newline at end of file diff --git a/api/C_Scenario.IsInScenario.lua b/api/C_Scenario.IsInScenario.lua new file mode 100644 index 0000000..7ace249 --- /dev/null +++ b/api/C_Scenario.IsInScenario.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Scenario.IsInScenario() end \ No newline at end of file diff --git a/api/C_Scenario.TreatScenarioAsDungeon.lua b/api/C_Scenario.TreatScenarioAsDungeon.lua new file mode 100644 index 0000000..36e4fa4 --- /dev/null +++ b/api/C_Scenario.TreatScenarioAsDungeon.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Scenario.TreatScenarioAsDungeon() end \ No newline at end of file diff --git a/api/C_TaskQuest.GetQuestObjectiveStrByQuestID.lua b/api/C_TaskQuest.GetQuestObjectiveStrByQuestID.lua new file mode 100644 index 0000000..30f3055 --- /dev/null +++ b/api/C_TaskQuest.GetQuestObjectiveStrByQuestID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_TaskQuest.GetQuestObjectiveStrByQuestID() end \ No newline at end of file diff --git a/api/C_TaskQuest.GetQuestTitleByQuestID.lua b/api/C_TaskQuest.GetQuestTitleByQuestID.lua new file mode 100644 index 0000000..4cbfc8a --- /dev/null +++ b/api/C_TaskQuest.GetQuestTitleByQuestID.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@return string name +---Return the name of a quest with a given ID +function C_TaskQuest.GetQuestTitleByQuestID(id) end \ No newline at end of file diff --git a/api/C_TaskQuest.GetQuestsForPlayerByMapID.lua b/api/C_TaskQuest.GetQuestsForPlayerByMapID.lua new file mode 100644 index 0000000..1d3b14b --- /dev/null +++ b/api/C_TaskQuest.GetQuestsForPlayerByMapID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_TaskQuest.GetQuestsForPlayerByMapID() end \ No newline at end of file diff --git a/api/C_Timer.After.lua b/api/C_Timer.After.lua new file mode 100644 index 0000000..fde529c --- /dev/null +++ b/api/C_Timer.After.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param duration number +---@param callback function +---Creates and starts a timer that calls 'callback' after 'duration' seconds.. The timer resolution will only be correct after the character is fully in the game, due to the underlying mechanism being tied to frame draws. +function C_Timer.After(duration, callback) end \ No newline at end of file diff --git a/api/C_ToyBox.ClearAllSourceTypesFiltered.lua b/api/C_ToyBox.ClearAllSourceTypesFiltered.lua new file mode 100644 index 0000000..13e5c9c --- /dev/null +++ b/api/C_ToyBox.ClearAllSourceTypesFiltered.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_ToyBox.ClearAllSourceTypesFiltered() end \ No newline at end of file diff --git a/api/C_ToyBox.FilterToys.lua b/api/C_ToyBox.FilterToys.lua new file mode 100644 index 0000000..a9d3eb5 --- /dev/null +++ b/api/C_ToyBox.FilterToys.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_ToyBox.FilterToys() end \ No newline at end of file diff --git a/api/C_ToyBox.GetFilterCollected.lua b/api/C_ToyBox.GetFilterCollected.lua new file mode 100644 index 0000000..00ca5e6 --- /dev/null +++ b/api/C_ToyBox.GetFilterCollected.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_ToyBox.GetFilterCollected() end \ No newline at end of file diff --git a/api/C_ToyBox.GetFilterUncollected.lua b/api/C_ToyBox.GetFilterUncollected.lua new file mode 100644 index 0000000..186676b --- /dev/null +++ b/api/C_ToyBox.GetFilterUncollected.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_ToyBox.GetFilterUncollected() end \ No newline at end of file diff --git a/api/C_ToyBox.GetIsFavorite.lua b/api/C_ToyBox.GetIsFavorite.lua new file mode 100644 index 0000000..2738877 --- /dev/null +++ b/api/C_ToyBox.GetIsFavorite.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_ToyBox.GetIsFavorite() end \ No newline at end of file diff --git a/api/C_ToyBox.GetNumFilteredToys.lua b/api/C_ToyBox.GetNumFilteredToys.lua new file mode 100644 index 0000000..0ea319e --- /dev/null +++ b/api/C_ToyBox.GetNumFilteredToys.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_ToyBox.GetNumFilteredToys() end \ No newline at end of file diff --git a/api/C_ToyBox.GetNumLearnedDisplayedToys.lua b/api/C_ToyBox.GetNumLearnedDisplayedToys.lua new file mode 100644 index 0000000..6c7bdeb --- /dev/null +++ b/api/C_ToyBox.GetNumLearnedDisplayedToys.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_ToyBox.GetNumLearnedDisplayedToys() end \ No newline at end of file diff --git a/api/C_ToyBox.GetNumTotalDisplayedToys.lua b/api/C_ToyBox.GetNumTotalDisplayedToys.lua new file mode 100644 index 0000000..7a7917d --- /dev/null +++ b/api/C_ToyBox.GetNumTotalDisplayedToys.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_ToyBox.GetNumTotalDisplayedToys() end \ No newline at end of file diff --git a/api/C_ToyBox.GetNumToys.lua b/api/C_ToyBox.GetNumToys.lua new file mode 100644 index 0000000..4ced626 --- /dev/null +++ b/api/C_ToyBox.GetNumToys.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_ToyBox.GetNumToys() end \ No newline at end of file diff --git a/api/C_ToyBox.GetToyFromIndex.lua b/api/C_ToyBox.GetToyFromIndex.lua new file mode 100644 index 0000000..71a506a --- /dev/null +++ b/api/C_ToyBox.GetToyFromIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_ToyBox.GetToyFromIndex() end \ No newline at end of file diff --git a/api/C_ToyBox.GetToyInfo.lua b/api/C_ToyBox.GetToyInfo.lua new file mode 100644 index 0000000..db30710 --- /dev/null +++ b/api/C_ToyBox.GetToyInfo.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemID number +---@return number itemID +---@return string name +---@return string texture +---@return boolean collected +---Returns information about an item by id. Returns a item information for a given toy or nil if no data exists. +function C_ToyBox.GetToyInfo(itemID) end \ No newline at end of file diff --git a/api/C_ToyBox.GetToyLink.lua b/api/C_ToyBox.GetToyLink.lua new file mode 100644 index 0000000..3d40eeb --- /dev/null +++ b/api/C_ToyBox.GetToyLink.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_ToyBox.GetToyLink() end \ No newline at end of file diff --git a/api/C_ToyBox.HasFavorites.lua b/api/C_ToyBox.HasFavorites.lua new file mode 100644 index 0000000..9316c70 --- /dev/null +++ b/api/C_ToyBox.HasFavorites.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_ToyBox.HasFavorites() end \ No newline at end of file diff --git a/api/C_ToyBox.IsSourceTypeFiltered.lua b/api/C_ToyBox.IsSourceTypeFiltered.lua new file mode 100644 index 0000000..9687daa --- /dev/null +++ b/api/C_ToyBox.IsSourceTypeFiltered.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_ToyBox.IsSourceTypeFiltered() end \ No newline at end of file diff --git a/api/C_ToyBox.PickupToyBoxItem.lua b/api/C_ToyBox.PickupToyBoxItem.lua new file mode 100644 index 0000000..0fa6c2b --- /dev/null +++ b/api/C_ToyBox.PickupToyBoxItem.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_ToyBox.PickupToyBoxItem() end \ No newline at end of file diff --git a/api/C_ToyBox.SetAllSourceTypesFiltered.lua b/api/C_ToyBox.SetAllSourceTypesFiltered.lua new file mode 100644 index 0000000..4e61791 --- /dev/null +++ b/api/C_ToyBox.SetAllSourceTypesFiltered.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_ToyBox.SetAllSourceTypesFiltered() end \ No newline at end of file diff --git a/api/C_ToyBox.SetFilterCollected.lua b/api/C_ToyBox.SetFilterCollected.lua new file mode 100644 index 0000000..e5d35b1 --- /dev/null +++ b/api/C_ToyBox.SetFilterCollected.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_ToyBox.SetFilterCollected() end \ No newline at end of file diff --git a/api/C_ToyBox.SetFilterSourceType.lua b/api/C_ToyBox.SetFilterSourceType.lua new file mode 100644 index 0000000..238b172 --- /dev/null +++ b/api/C_ToyBox.SetFilterSourceType.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_ToyBox.SetFilterSourceType() end \ No newline at end of file diff --git a/api/C_ToyBox.SetFilterString.lua b/api/C_ToyBox.SetFilterString.lua new file mode 100644 index 0000000..ba11a2f --- /dev/null +++ b/api/C_ToyBox.SetFilterString.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_ToyBox.SetFilterString() end \ No newline at end of file diff --git a/api/C_ToyBox.SetFilterUncollected.lua b/api/C_ToyBox.SetFilterUncollected.lua new file mode 100644 index 0000000..fa5cf28 --- /dev/null +++ b/api/C_ToyBox.SetFilterUncollected.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_ToyBox.SetFilterUncollected() end \ No newline at end of file diff --git a/api/C_ToyBox.SetIsFavorite.lua b/api/C_ToyBox.SetIsFavorite.lua new file mode 100644 index 0000000..09832ee --- /dev/null +++ b/api/C_ToyBox.SetIsFavorite.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_ToyBox.SetIsFavorite() end \ No newline at end of file diff --git a/api/C_Trophy.MonumentChangeAppearanceToTrophyID.lua b/api/C_Trophy.MonumentChangeAppearanceToTrophyID.lua new file mode 100644 index 0000000..9653f36 --- /dev/null +++ b/api/C_Trophy.MonumentChangeAppearanceToTrophyID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Trophy.MonumentChangeAppearanceToTrophyID() end \ No newline at end of file diff --git a/api/C_Trophy.MonumentCloseMonumentUI.lua b/api/C_Trophy.MonumentCloseMonumentUI.lua new file mode 100644 index 0000000..4260051 --- /dev/null +++ b/api/C_Trophy.MonumentCloseMonumentUI.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Trophy.MonumentCloseMonumentUI() end \ No newline at end of file diff --git a/api/C_Trophy.MonumentGetCount.lua b/api/C_Trophy.MonumentGetCount.lua new file mode 100644 index 0000000..1c3d77a --- /dev/null +++ b/api/C_Trophy.MonumentGetCount.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Trophy.MonumentGetCount() end \ No newline at end of file diff --git a/api/C_Trophy.MonumentGetSelectedTrophyID.lua b/api/C_Trophy.MonumentGetSelectedTrophyID.lua new file mode 100644 index 0000000..cb63905 --- /dev/null +++ b/api/C_Trophy.MonumentGetSelectedTrophyID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Trophy.MonumentGetSelectedTrophyID() end \ No newline at end of file diff --git a/api/C_Trophy.MonumentGetTrophyInfoByIndex.lua b/api/C_Trophy.MonumentGetTrophyInfoByIndex.lua new file mode 100644 index 0000000..6c823da --- /dev/null +++ b/api/C_Trophy.MonumentGetTrophyInfoByIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Trophy.MonumentGetTrophyInfoByIndex() end \ No newline at end of file diff --git a/api/C_Trophy.MonumentLoadList.lua b/api/C_Trophy.MonumentLoadList.lua new file mode 100644 index 0000000..ca9368e --- /dev/null +++ b/api/C_Trophy.MonumentLoadList.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Trophy.MonumentLoadList() end \ No newline at end of file diff --git a/api/C_Trophy.MonumentLoadSelectedTrophyID.lua b/api/C_Trophy.MonumentLoadSelectedTrophyID.lua new file mode 100644 index 0000000..cb5b944 --- /dev/null +++ b/api/C_Trophy.MonumentLoadSelectedTrophyID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Trophy.MonumentLoadSelectedTrophyID() end \ No newline at end of file diff --git a/api/C_Trophy.MonumentRevertAppearanceToSaved.lua b/api/C_Trophy.MonumentRevertAppearanceToSaved.lua new file mode 100644 index 0000000..e8fac65 --- /dev/null +++ b/api/C_Trophy.MonumentRevertAppearanceToSaved.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Trophy.MonumentRevertAppearanceToSaved() end \ No newline at end of file diff --git a/api/C_Trophy.MonumentSaveSelection.lua b/api/C_Trophy.MonumentSaveSelection.lua new file mode 100644 index 0000000..b533419 --- /dev/null +++ b/api/C_Trophy.MonumentSaveSelection.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function C_Trophy.MonumentSaveSelection() end \ No newline at end of file diff --git a/api/CalculateAuctionDeposit.lua b/api/CalculateAuctionDeposit.lua new file mode 100644 index 0000000..e40c98f --- /dev/null +++ b/api/CalculateAuctionDeposit.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param runTime 2880 +---@param 720 +---@param 1440 +---@param 2880 +---@return number deposit +---Returns the deposit amount for the item currently being set up for auction. Only returns useful information once an item has been placed in the Create Auction UI's "auction item" slot (see ClickAuctionSellItemButton()). Deposit amount for an auction varies based on the item being auction, the auction's proposed run time, and the auction house being used (i.e. faction or neutral). +function CalculateAuctionDeposit(runTime, 720, 1440, 2880) end \ No newline at end of file diff --git a/api/CalendarAddEvent.lua b/api/CalendarAddEvent.lua new file mode 100644 index 0000000..067425e --- /dev/null +++ b/api/CalendarAddEvent.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Saves the event recently created (and selected for editing) to the calendar. Until this function is called, an event created with CalendarNewEvent(), CalendarNewGuildEvent(), or CalendarNewGuildAnnouncement() will not exist on the calendar -- that is, guild members or invitees will not see it, and it will not persist if the player closes the calendar, reloads the UI, or goes to view or edit another event. +function CalendarAddEvent() end \ No newline at end of file diff --git a/api/CalendarCanAddEvent.lua b/api/CalendarCanAddEvent.lua new file mode 100644 index 0000000..0e9c164 --- /dev/null +++ b/api/CalendarCanAddEvent.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean canAdd +---Returns whether the player can add an event to the calendar +function CalendarCanAddEvent() end \ No newline at end of file diff --git a/api/CalendarCanSendInvite.lua b/api/CalendarCanSendInvite.lua new file mode 100644 index 0000000..98a0bd6 --- /dev/null +++ b/api/CalendarCanSendInvite.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean canInvite +---Returns whether the player can invite others to a calendar event +function CalendarCanSendInvite() end \ No newline at end of file diff --git a/api/CalendarCloseEvent.lua b/api/CalendarCloseEvent.lua new file mode 100644 index 0000000..7739143 --- /dev/null +++ b/api/CalendarCloseEvent.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Deselects (ends viewing/editing on) an event. After calling this function, results of attempting to query or change event information are not guaranteed until a new event is created or another existing event is opened. +function CalendarCloseEvent() end \ No newline at end of file diff --git a/api/CalendarContextDeselectEvent.lua b/api/CalendarContextDeselectEvent.lua new file mode 100644 index 0000000..9d35341 --- /dev/null +++ b/api/CalendarContextDeselectEvent.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Clears the event selection used only for CalendarContext functions. The selection state cleared by this function is used only by other CalendarContext functions; other calendar event functions use the selection state set by CalendarOpenEvent, CalendarNewEvent, CalendarNewGuildEvent, or CalendarNewGuildAnnouncement (if they use a selection state at all). +function CalendarContextDeselectEvent() end \ No newline at end of file diff --git a/api/CalendarContextEventCanComplain.lua b/api/CalendarContextEventCanComplain.lua new file mode 100644 index 0000000..47032d6 --- /dev/null +++ b/api/CalendarContextEventCanComplain.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param monthOffset CalendarContextSelectEvent +---@param -1 +---@param 0 +---@param 1 +---@param nil CalendarContextSelectEvent +---@param day number +---@param index number +---@return boolean canReport +---Returns whether the player can report an event invitation as spam. If all arguments are omitted, uses the event selected by CalendarContextSelectEvent. +function CalendarContextEventCanComplain(monthOffset, -1, 0, 1, nil, day, index) end \ No newline at end of file diff --git a/api/CalendarContextEventCanEdit.lua b/api/CalendarContextEventCanEdit.lua new file mode 100644 index 0000000..d03747f --- /dev/null +++ b/api/CalendarContextEventCanEdit.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param monthOffset CalendarContextSelectEvent +---@param -1 +---@param 0 +---@param 1 +---@param nil CalendarContextSelectEvent +---@param day number +---@param index number +---@return boolean canEdit +---Returns whether the player can edit an event +function CalendarContextEventCanEdit(monthOffset, -1, 0, 1, nil, day, index) end \ No newline at end of file diff --git a/api/CalendarContextEventCanRemove.lua b/api/CalendarContextEventCanRemove.lua new file mode 100644 index 0000000..c3cfd57 --- /dev/null +++ b/api/CalendarContextEventCanRemove.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CalendarContextEventCanRemove() end \ No newline at end of file diff --git a/api/CalendarContextEventClipboard.lua b/api/CalendarContextEventClipboard.lua new file mode 100644 index 0000000..88089a3 --- /dev/null +++ b/api/CalendarContextEventClipboard.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean canPaste +---Returns whether the player can paste an event +function CalendarContextEventClipboard() end \ No newline at end of file diff --git a/api/CalendarContextEventComplain.lua b/api/CalendarContextEventComplain.lua new file mode 100644 index 0000000..43f823b --- /dev/null +++ b/api/CalendarContextEventComplain.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param monthOffset CalendarContextSelectEvent +---@param -1 +---@param 0 +---@param 1 +---@param nil CalendarContextSelectEvent +---@param day number +---@param index number +---Reports an event invitation as spam +function CalendarContextEventComplain(monthOffset, -1, 0, 1, nil, day, index) end \ No newline at end of file diff --git a/api/CalendarContextEventCopy.lua b/api/CalendarContextEventCopy.lua new file mode 100644 index 0000000..94c565c --- /dev/null +++ b/api/CalendarContextEventCopy.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param monthOffset CalendarContextSelectEvent +---@param -1 +---@param 0 +---@param 1 +---@param nil CalendarContextSelectEvent +---@param day number +---@param index number +---Copies an event for later pasting +function CalendarContextEventCopy(monthOffset, -1, 0, 1, nil, day, index) end \ No newline at end of file diff --git a/api/CalendarContextEventGetCalendarType.lua b/api/CalendarContextEventGetCalendarType.lua new file mode 100644 index 0000000..8c2e48b --- /dev/null +++ b/api/CalendarContextEventGetCalendarType.lua @@ -0,0 +1,19 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param monthOffset CalendarContextSelectEvent +---@param -1 +---@param 0 +---@param 1 +---@param nil CalendarContextSelectEvent +---@param day number +---@param index number +---@return SYSTEM calendarType +---@return GUILD_ANNOUNCEMENT +---@return GUILD_EVENT +---@return HOLIDAY +---@return PLAYER +---@return RAID_LOCKOUT +---@return RAID_RESET +---@return SYSTEM +---Returns the type of a calendar event. If all arguments are omitted, uses the event selected by CalendarContextSelectEvent. +function CalendarContextEventGetCalendarType(monthOffset, -1, 0, 1, nil, day, index) end \ No newline at end of file diff --git a/api/CalendarContextEventPaste.lua b/api/CalendarContextEventPaste.lua new file mode 100644 index 0000000..8bc76cc --- /dev/null +++ b/api/CalendarContextEventPaste.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param monthOffset 1 +---@param -1 +---@param 0 +---@param 1 +---@param day number +---Pastes a copied event into a given date. Does nothing if no event has been copied via CalendarContextEventCopy. +function CalendarContextEventPaste(monthOffset, -1, 0, 1, day) end \ No newline at end of file diff --git a/api/CalendarContextEventRemove.lua b/api/CalendarContextEventRemove.lua new file mode 100644 index 0000000..35136d2 --- /dev/null +++ b/api/CalendarContextEventRemove.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param monthOffset CalendarContextSelectEvent +---@param -1 +---@param 0 +---@param 1 +---@param nil CalendarContextSelectEvent +---@param day number +---@param index number +---Deletes an event from the calendar +function CalendarContextEventRemove(monthOffset, -1, 0, 1, nil, day, index) end \ No newline at end of file diff --git a/api/CalendarContextEventSignUp.lua b/api/CalendarContextEventSignUp.lua new file mode 100644 index 0000000..b6751fc --- /dev/null +++ b/api/CalendarContextEventSignUp.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param monthOffset CalendarContextSelectEvent +---@param -1 +---@param 0 +---@param 1 +---@param nil CalendarContextSelectEvent +---@param day number +---@param index number +---Signs the player up for a guild event +function CalendarContextEventSignUp(monthOffset, -1, 0, 1, nil, day, index) end \ No newline at end of file diff --git a/api/CalendarContextGetEventIndex.lua b/api/CalendarContextGetEventIndex.lua new file mode 100644 index 0000000..5b10866 --- /dev/null +++ b/api/CalendarContextGetEventIndex.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1 monthOffset +---@return -1 +---@return 0 +---@return 1 +---@return number day +---@return number index +---Returns the month, day, and index of the event selection used only for CalendarContext functions. The selection state referenced by this function is used only by other CalendarContext functions; other calendar event functions use the selection state set by CalendarOpenEvent, CalendarNewEvent, CalendarNewGuildEvent, or CalendarNewGuildAnnouncement (if they use a selection state at all). Used in the default UI to implement the calendar's context menu (on right-click). +function CalendarContextGetEventIndex() end \ No newline at end of file diff --git a/api/CalendarContextInviteAvailable.lua b/api/CalendarContextInviteAvailable.lua new file mode 100644 index 0000000..a8e6881 --- /dev/null +++ b/api/CalendarContextInviteAvailable.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param monthOffset CalendarContextSelectEvent +---@param -1 +---@param 0 +---@param 1 +---@param nil CalendarContextSelectEvent +---@param day number +---@param index number +---Accepts an event invitation +function CalendarContextInviteAvailable(monthOffset, -1, 0, 1, nil, day, index) end \ No newline at end of file diff --git a/api/CalendarContextInviteDecline.lua b/api/CalendarContextInviteDecline.lua new file mode 100644 index 0000000..6e56481 --- /dev/null +++ b/api/CalendarContextInviteDecline.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param monthOffset CalendarContextSelectEvent +---@param -1 +---@param 0 +---@param 1 +---@param nil CalendarContextSelectEvent +---@param day number +---@param index number +---Declines an event invitation +function CalendarContextInviteDecline(monthOffset, -1, 0, 1, nil, day, index) end \ No newline at end of file diff --git a/api/CalendarContextInviteIsPending.lua b/api/CalendarContextInviteIsPending.lua new file mode 100644 index 0000000..f39f7e0 --- /dev/null +++ b/api/CalendarContextInviteIsPending.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param monthOffset CalendarContextSelectEvent +---@param -1 +---@param 0 +---@param 1 +---@param nil CalendarContextSelectEvent +---@param day number +---@param index number +---@return boolean pendingInvite +---Returns whether the player has been invited to an event and not yet responded +function CalendarContextInviteIsPending(monthOffset, -1, 0, 1, nil, day, index) end \ No newline at end of file diff --git a/api/CalendarContextInviteModeratorStatus.lua b/api/CalendarContextInviteModeratorStatus.lua new file mode 100644 index 0000000..01a4b4f --- /dev/null +++ b/api/CalendarContextInviteModeratorStatus.lua @@ -0,0 +1,14 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param monthOffset CalendarContextSelectEvent +---@param -1 +---@param 0 +---@param 1 +---@param nil CalendarContextSelectEvent +---@param day number +---@param index number +---@return MODERATOR modStatus +---@return CREATOR +---@return MODERATOR +---Returns the player's moderator status for an event +function CalendarContextInviteModeratorStatus(monthOffset, -1, 0, 1, nil, day, index) end \ No newline at end of file diff --git a/api/CalendarContextInviteRemove.lua b/api/CalendarContextInviteRemove.lua new file mode 100644 index 0000000..2324de1 --- /dev/null +++ b/api/CalendarContextInviteRemove.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param monthOffset CalendarContextSelectEvent +---@param -1 +---@param 0 +---@param 1 +---@param nil CalendarContextSelectEvent +---@param day number +---@param index number +---Removes an invitation from the player's calendar or removes the player from a guild event's signup list +function CalendarContextInviteRemove(monthOffset, -1, 0, 1, nil, day, index) end \ No newline at end of file diff --git a/api/CalendarContextInviteStatus.lua b/api/CalendarContextInviteStatus.lua new file mode 100644 index 0000000..fb9d1eb --- /dev/null +++ b/api/CalendarContextInviteStatus.lua @@ -0,0 +1,20 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param monthOffset CalendarContextSelectEvent +---@param -1 +---@param 0 +---@param 1 +---@param nil CalendarContextSelectEvent +---@param day number +---@param index number +---@return 8 inviteStatus +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---@return 5 +---@return 6 +---@return 7 +---@return 8 +---Returns the player's invite status for an event +function CalendarContextInviteStatus(monthOffset, -1, 0, 1, nil, day, index) end \ No newline at end of file diff --git a/api/CalendarContextInviteTentative.lua b/api/CalendarContextInviteTentative.lua new file mode 100644 index 0000000..4b67290 --- /dev/null +++ b/api/CalendarContextInviteTentative.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CalendarContextInviteTentative() end \ No newline at end of file diff --git a/api/CalendarContextInviteType.lua b/api/CalendarContextInviteType.lua new file mode 100644 index 0000000..51845e2 --- /dev/null +++ b/api/CalendarContextInviteType.lua @@ -0,0 +1,14 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param monthOffset CalendarContextSelectEvent +---@param -1 +---@param 0 +---@param 1 +---@param nil CalendarContextSelectEvent +---@param day number +---@param index number +---@return 2 inviteType +---@return 1 +---@return 2 +---Returns the invite type for an event +function CalendarContextInviteType(monthOffset, -1, 0, 1, nil, day, index) end \ No newline at end of file diff --git a/api/CalendarContextSelectEvent.lua b/api/CalendarContextSelectEvent.lua new file mode 100644 index 0000000..d2851e8 --- /dev/null +++ b/api/CalendarContextSelectEvent.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param monthOffset CalendarContextSelectEvent +---@param -1 +---@param 0 +---@param 1 +---@param nil CalendarContextSelectEvent +---@param day number +---@param index number +---Selects an event for use only with other CalendarContext functions. The selection state set by this function is used only by other CalendarContext functions; other calendar event functions use the selection state set by CalendarOpenEvent, CalendarNewEvent, CalendarNewGuildEvent, or CalendarNewGuildAnnouncement (if they use a selection state at all). Used in the default UI to implement the calendar's context menu (on right-click). +function CalendarContextSelectEvent(monthOffset, -1, 0, 1, nil, day, index) end \ No newline at end of file diff --git a/api/CalendarDefaultGuildFilter.lua b/api/CalendarDefaultGuildFilter.lua new file mode 100644 index 0000000..b6ff049 --- /dev/null +++ b/api/CalendarDefaultGuildFilter.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number minLevel +---@return number maxLevel +---@return number rank +---Returns default options for the guild member Mass Invite filter +function CalendarDefaultGuildFilter() end \ No newline at end of file diff --git a/api/CalendarEventAvailable.lua b/api/CalendarEventAvailable.lua new file mode 100644 index 0000000..769d91f --- /dev/null +++ b/api/CalendarEventAvailable.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Accepts invitation to the selected calendar event. Only applies to player-created events and invitations sent by other players; has no effect if the current calendar event is of another type. +function CalendarEventAvailable() end \ No newline at end of file diff --git a/api/CalendarEventCanEdit.lua b/api/CalendarEventCanEdit.lua new file mode 100644 index 0000000..56df1b4 --- /dev/null +++ b/api/CalendarEventCanEdit.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean canEdit +---Returns whether the player can edit the selected calendar event +function CalendarEventCanEdit() end \ No newline at end of file diff --git a/api/CalendarEventCanModerate.lua b/api/CalendarEventCanModerate.lua new file mode 100644 index 0000000..d008b86 --- /dev/null +++ b/api/CalendarEventCanModerate.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return boolean canModerate +---Returns whether an event invitee can be granted moderator authority +function CalendarEventCanModerate(index) end \ No newline at end of file diff --git a/api/CalendarEventClearAutoApprove.lua b/api/CalendarEventClearAutoApprove.lua new file mode 100644 index 0000000..3c1501e --- /dev/null +++ b/api/CalendarEventClearAutoApprove.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Disables the auto-approve feature (currently unused) for the selected calendar event +function CalendarEventClearAutoApprove() end \ No newline at end of file diff --git a/api/CalendarEventClearLocked.lua b/api/CalendarEventClearLocked.lua new file mode 100644 index 0000000..d733549 --- /dev/null +++ b/api/CalendarEventClearLocked.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Unlocks the selected calendar event. Locked events do not allow invitees to respond or guild members to sign up, but can still be edited. +function CalendarEventClearLocked() end \ No newline at end of file diff --git a/api/CalendarEventClearModerator.lua b/api/CalendarEventClearModerator.lua new file mode 100644 index 0000000..c08476f --- /dev/null +++ b/api/CalendarEventClearModerator.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Removes moderator status from a character on the selected event's invite/signup list. Moderators can change the status of characters on the invite/signup list and invite more characters, but cannot otherwise edit the event. +function CalendarEventClearModerator(index) end \ No newline at end of file diff --git a/api/CalendarEventDecline.lua b/api/CalendarEventDecline.lua new file mode 100644 index 0000000..a9b48c6 --- /dev/null +++ b/api/CalendarEventDecline.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Declines invitation to the selected calendar event. Only applies to player-created events and invitations sent by other players; has no effect if the current calendar event is of another type. +function CalendarEventDecline() end \ No newline at end of file diff --git a/api/CalendarEventGetCalendarType.lua b/api/CalendarEventGetCalendarType.lua new file mode 100644 index 0000000..8357bbe --- /dev/null +++ b/api/CalendarEventGetCalendarType.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return PLAYER calendarType +---@return GUILD_ANNOUNCEMENT +---@return GUILD_EVENT +---@return PLAYER +---Returns the type of the selected calendar event +function CalendarEventGetCalendarType() end \ No newline at end of file diff --git a/api/CalendarEventGetInvite.lua b/api/CalendarEventGetInvite.lua new file mode 100644 index 0000000..08ffcf4 --- /dev/null +++ b/api/CalendarEventGetInvite.lua @@ -0,0 +1,24 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---@return number level +---@return string className +---@return string classFileName +---@return 7 inviteStatus +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---@return 5 +---@return 6 +---@return 7 +---@return MODERATOR modStatus +---@return CREATOR +---@return MODERATOR +---@return boolean inviteIsMine +---@return 2 inviteType +---@return 1 +---@return 2 +---Returns information about an entry in the selected event's invite/signup list +function CalendarEventGetInvite(index) end \ No newline at end of file diff --git a/api/CalendarEventGetInviteResponseTime.lua b/api/CalendarEventGetInviteResponseTime.lua new file mode 100644 index 0000000..4637101 --- /dev/null +++ b/api/CalendarEventGetInviteResponseTime.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number weekday +---@return number month +---@return number day +---@return number year +---@return number hour +---@return number minute +---Returns the time at which a character on the selected event's invite/signup list responded. Returns all zeros if the character has not yet responded or is the event's creator. +function CalendarEventGetInviteResponseTime(index) end \ No newline at end of file diff --git a/api/CalendarEventGetInviteSortCriterion.lua b/api/CalendarEventGetInviteSortCriterion.lua new file mode 100644 index 0000000..8a9b825 --- /dev/null +++ b/api/CalendarEventGetInviteSortCriterion.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return status criterion +---@return CLASS_SORT_ORDER class +---@return name +---@return status +---@return boolean reverse +---Returns the current sort mode for the event invite/signup list +function CalendarEventGetInviteSortCriterion() end \ No newline at end of file diff --git a/api/CalendarEventGetNumInvites.lua b/api/CalendarEventGetNumInvites.lua new file mode 100644 index 0000000..2b0a7f3 --- /dev/null +++ b/api/CalendarEventGetNumInvites.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numInvites +---Returns the number of characters on the selected calendar event's invite/signup list +function CalendarEventGetNumInvites() end \ No newline at end of file diff --git a/api/CalendarEventGetRepeatOptions.lua b/api/CalendarEventGetRepeatOptions.lua new file mode 100644 index 0000000..7817efc --- /dev/null +++ b/api/CalendarEventGetRepeatOptions.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return list ... +---Returns a list of localized event repetition option labels (currently unused) +function CalendarEventGetRepeatOptions() end \ No newline at end of file diff --git a/api/CalendarEventGetSelectedInvite.lua b/api/CalendarEventGetSelectedInvite.lua new file mode 100644 index 0000000..ed24691 --- /dev/null +++ b/api/CalendarEventGetSelectedInvite.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number index +---Returns the index of the selected entry on the selected event's invite/signup list. In the current default UI, selection behavior in the invite list is implemented but disabled; selecting an invite list entry has no effect on the behavior of other APIs. +function CalendarEventGetSelectedInvite() end \ No newline at end of file diff --git a/api/CalendarEventGetStatusOptions.lua b/api/CalendarEventGetStatusOptions.lua new file mode 100644 index 0000000..47f657d --- /dev/null +++ b/api/CalendarEventGetStatusOptions.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return list ... +---Returns a list of localized invite status labels +function CalendarEventGetStatusOptions() end \ No newline at end of file diff --git a/api/CalendarEventGetTextures.lua b/api/CalendarEventGetTextures.lua new file mode 100644 index 0000000..dd86cdd --- /dev/null +++ b/api/CalendarEventGetTextures.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param eventType 2 +---@param 1 +---@param 2 +---@return string name +---@return string icon +---@return number expansion +---Returns a list of instance names and icons for dungeon or raid events +function CalendarEventGetTextures(eventType, 1, 2) end \ No newline at end of file diff --git a/api/CalendarEventGetTypes.lua b/api/CalendarEventGetTypes.lua new file mode 100644 index 0000000..1237b70 --- /dev/null +++ b/api/CalendarEventGetTypes.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return list ... +---Returns a list of event display style labels +function CalendarEventGetTypes() end \ No newline at end of file diff --git a/api/CalendarEventGetTypesDisplayOrdered.lua b/api/CalendarEventGetTypesDisplayOrdered.lua new file mode 100644 index 0000000..ed32ec8 --- /dev/null +++ b/api/CalendarEventGetTypesDisplayOrdered.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CalendarEventGetTypesDisplayOrdered() end \ No newline at end of file diff --git a/api/CalendarEventHasPendingInvite.lua b/api/CalendarEventHasPendingInvite.lua new file mode 100644 index 0000000..eb9cd27 --- /dev/null +++ b/api/CalendarEventHasPendingInvite.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean pendingInvite +---Returns whether the player has been invited to the selected event and not yet responded +function CalendarEventHasPendingInvite() end \ No newline at end of file diff --git a/api/CalendarEventHaveSettingsChanged.lua b/api/CalendarEventHaveSettingsChanged.lua new file mode 100644 index 0000000..1395089 --- /dev/null +++ b/api/CalendarEventHaveSettingsChanged.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean settingsChanged +---Returns whether the selected event has unsaved changes +function CalendarEventHaveSettingsChanged() end \ No newline at end of file diff --git a/api/CalendarEventInvite.lua b/api/CalendarEventInvite.lua new file mode 100644 index 0000000..0711804 --- /dev/null +++ b/api/CalendarEventInvite.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---Attempts to invite a character to the selected event. If successful, the CALENDAR_UPDATE_INVITE_LIST event fires indicating the character has been added to the invite list; otherwise the CALENDAR_UPDATE_ERROR event fires containing a localized error message. +function CalendarEventInvite(name) end \ No newline at end of file diff --git a/api/CalendarEventIsModerator.lua b/api/CalendarEventIsModerator.lua new file mode 100644 index 0000000..97a11ff --- /dev/null +++ b/api/CalendarEventIsModerator.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean isModerator +---Returns whether the player has moderator status for the selected calendar event. Also returns true if the player is the event's creator. +function CalendarEventIsModerator() end \ No newline at end of file diff --git a/api/CalendarEventRemoveInvite.lua b/api/CalendarEventRemoveInvite.lua new file mode 100644 index 0000000..82acc06 --- /dev/null +++ b/api/CalendarEventRemoveInvite.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Removes a character from the selected event's invite/signup list. Cannot be used to remove the event's creator (fires a CALENDAR_UPDATE_ERROR event with nil error message if such is attempted). +function CalendarEventRemoveInvite(index) end \ No newline at end of file diff --git a/api/CalendarEventSelectInvite.lua b/api/CalendarEventSelectInvite.lua new file mode 100644 index 0000000..0a34ab7 --- /dev/null +++ b/api/CalendarEventSelectInvite.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Selects an entry in the selected event's invite/signup list. In the current default UI, selection behavior in the invite list is implemented but disabled; selecting an invite list entry has no effect on the behavior of other APIs. +function CalendarEventSelectInvite(index) end \ No newline at end of file diff --git a/api/CalendarEventSetAutoApprove.lua b/api/CalendarEventSetAutoApprove.lua new file mode 100644 index 0000000..6134c92 --- /dev/null +++ b/api/CalendarEventSetAutoApprove.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Enables the auto-approve feature (currently unused) for the selected calendar event +function CalendarEventSetAutoApprove() end \ No newline at end of file diff --git a/api/CalendarEventSetDate.lua b/api/CalendarEventSetDate.lua new file mode 100644 index 0000000..a67a0bd --- /dev/null +++ b/api/CalendarEventSetDate.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param month number +---@param day number +---@param year number +---Changes the scheduled date of the selected calendar event +function CalendarEventSetDate(month, day, year) end \ No newline at end of file diff --git a/api/CalendarEventSetDescription.lua b/api/CalendarEventSetDescription.lua new file mode 100644 index 0000000..341410e --- /dev/null +++ b/api/CalendarEventSetDescription.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param description string +---Changes the descriptive text for the selected event +function CalendarEventSetDescription(description) end \ No newline at end of file diff --git a/api/CalendarEventSetLocked.lua b/api/CalendarEventSetLocked.lua new file mode 100644 index 0000000..2feed73 --- /dev/null +++ b/api/CalendarEventSetLocked.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Locks the selected calendar event. Locked events do not allow invitees to respond or guild members to sign up, but can still be edited. +function CalendarEventSetLocked() end \ No newline at end of file diff --git a/api/CalendarEventSetLockoutDate.lua b/api/CalendarEventSetLockoutDate.lua new file mode 100644 index 0000000..7c59a72 --- /dev/null +++ b/api/CalendarEventSetLockoutDate.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param month number +---@param day number +---@param year number +---Changes the lockout date associated with the selected event (currently unused). This feature is not enabled in the current version of World of Warcraft; saving an event in which the lockout date has been changed will revert it to its default of 1, 1, 1, 2000 (January 1, 2000). +function CalendarEventSetLockoutDate(month, day, year) end \ No newline at end of file diff --git a/api/CalendarEventSetLockoutTime.lua b/api/CalendarEventSetLockoutTime.lua new file mode 100644 index 0000000..e713ff8 --- /dev/null +++ b/api/CalendarEventSetLockoutTime.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param hour number +---@param minute number +---Changes the lockout time associated with the selected event (currently unused). This feature is not enabled in the current version of World of Warcraft; saving an event in which the lockout time has been changed will revert it to its default of 0, 0 (midnight). +function CalendarEventSetLockoutTime(hour, minute) end \ No newline at end of file diff --git a/api/CalendarEventSetModerator.lua b/api/CalendarEventSetModerator.lua new file mode 100644 index 0000000..71fddd2 --- /dev/null +++ b/api/CalendarEventSetModerator.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Grants moderator status to a character on the selected event's invite/signup list. Moderators can change the status of characters on the invite/signup list and invite more characters, but cannot otherwise edit the event. +function CalendarEventSetModerator(index) end \ No newline at end of file diff --git a/api/CalendarEventSetRepeatOption.lua b/api/CalendarEventSetRepeatOption.lua new file mode 100644 index 0000000..8679263 --- /dev/null +++ b/api/CalendarEventSetRepeatOption.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param title number +---Changes the repetition option for the selected event (currently unused). This feature is not enabled in the current version of World of Warcraft; saving an event in which the repeat option has been changed will revert it to its default of 1 (Never). +function CalendarEventSetRepeatOption(title) end \ No newline at end of file diff --git a/api/CalendarEventSetSize.lua b/api/CalendarEventSetSize.lua new file mode 100644 index 0000000..2ac01f6 --- /dev/null +++ b/api/CalendarEventSetSize.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param size number +---Changes the maximum number of invites/signups for the selected event (currently unused). This feature is not enabled in the current version of World of Warcraft; saving an event in which the max size has been changed will revert it to its default of 100. +function CalendarEventSetSize(size) end \ No newline at end of file diff --git a/api/CalendarEventSetStatus.lua b/api/CalendarEventSetStatus.lua new file mode 100644 index 0000000..2cf0d27 --- /dev/null +++ b/api/CalendarEventSetStatus.lua @@ -0,0 +1,14 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param inviteStatus 8 +---@param 1 +---@param 2 +---@param 3 +---@param 4 +---@param 5 +---@param 6 +---@param 7 +---@param 8 +---Sets the status of a character on the selected event's invite/signup list +function CalendarEventSetStatus(index, inviteStatus, 1, 2, 3, 4, 5, 6, 7, 8) end \ No newline at end of file diff --git a/api/CalendarEventSetTextureID.lua b/api/CalendarEventSetTextureID.lua new file mode 100644 index 0000000..fadff48 --- /dev/null +++ b/api/CalendarEventSetTextureID.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Changes the raid or dungeon instance for the selected event. Only applicable if the event's eventType is set to 1 or 2 (see CalendarEventSetType). A list of dungeon or raid instances can be found by calling CalendarEventGetTextures with the current eventType. That function returns three values (name, icon, and expansion) for each instance in the list; e.g. to get the index for use with this function, find the index of the instance's name in that list and divide by 3. +function CalendarEventSetTextureID(index) end \ No newline at end of file diff --git a/api/CalendarEventSetTime.lua b/api/CalendarEventSetTime.lua new file mode 100644 index 0000000..d993203 --- /dev/null +++ b/api/CalendarEventSetTime.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param hour number +---@param minute number +---Changes the scheduled time of the selected event +function CalendarEventSetTime(hour, minute) end \ No newline at end of file diff --git a/api/CalendarEventSetTitle.lua b/api/CalendarEventSetTitle.lua new file mode 100644 index 0000000..5195666 --- /dev/null +++ b/api/CalendarEventSetTitle.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param title string +---Changes the title for the selected event +function CalendarEventSetTitle(title) end \ No newline at end of file diff --git a/api/CalendarEventSetType.lua b/api/CalendarEventSetType.lua new file mode 100644 index 0000000..de554f9 --- /dev/null +++ b/api/CalendarEventSetType.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param eventType 5 +---@param 1 +---@param 2 +---@param 3 +---@param 4 +---@param 5 +---Changes the display type of the selected event +function CalendarEventSetType(eventType, 1, 2, 3, 4, 5) end \ No newline at end of file diff --git a/api/CalendarEventSignUp.lua b/api/CalendarEventSignUp.lua new file mode 100644 index 0000000..2fb6d36 --- /dev/null +++ b/api/CalendarEventSignUp.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Signs the player up for the selected calendar event. Only applies to guild events; has no effect if called when the current calendar event is not a guild event. +function CalendarEventSignUp() end \ No newline at end of file diff --git a/api/CalendarEventSortInvites.lua b/api/CalendarEventSortInvites.lua new file mode 100644 index 0000000..17f5229 --- /dev/null +++ b/api/CalendarEventSortInvites.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param criterion status +---@param class CLASS_SORT_ORDER +---@param name +---@param status +---@param reverse boolean +---Sorts the event invite/signup list. Does not cause the list to automatically remain sorted; e.g. if sorted by status and a character's status is changed, the list will not be resorted until this function is called again. +function CalendarEventSortInvites(criterion, class, name, status, reverse) end \ No newline at end of file diff --git a/api/CalendarEventTentative.lua b/api/CalendarEventTentative.lua new file mode 100644 index 0000000..5c97440 --- /dev/null +++ b/api/CalendarEventTentative.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CalendarEventTentative() end \ No newline at end of file diff --git a/api/CalendarGetAbsMonth.lua b/api/CalendarGetAbsMonth.lua new file mode 100644 index 0000000..47c63ed --- /dev/null +++ b/api/CalendarGetAbsMonth.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param month number +---@param year number +---@return number month +---@return number year +---@return number numDays +---@return number firstWeekday +---Returns date information for a given month and year +function CalendarGetAbsMonth(month, year) end \ No newline at end of file diff --git a/api/CalendarGetDate.lua b/api/CalendarGetDate.lua new file mode 100644 index 0000000..a50594a --- /dev/null +++ b/api/CalendarGetDate.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number weekday +---@return number month +---@return number day +---@return number year +---Returns the current date (in the server's time zone). Only returns valid information after the PLAYER_LOGIN event has fired. +function CalendarGetDate() end \ No newline at end of file diff --git a/api/CalendarGetDayEvent.lua b/api/CalendarGetDayEvent.lua new file mode 100644 index 0000000..1b41f9c --- /dev/null +++ b/api/CalendarGetDayEvent.lua @@ -0,0 +1,53 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param monthOffset 1 +---@param -1 +---@param 0 +---@param 1 +---@param day number +---@param index number +---@return string title +---@return number hour +---@return number minute +---@return SYSTEM calendarType +---@return GUILD_ANNOUNCEMENT +---@return GUILD_EVENT +---@return HOLIDAY +---@return PLAYER +---@return RAID_LOCKOUT +---@return RAID_RESET +---@return SYSTEM +---@return START sequenceType +---@return END +---@return INFO +---@return ONGOING +---@return START +---@return 5 eventType +---@return 0 +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---@return 5 +---@return string texture +---@return MODERATOR modStatus +---@return CREATOR +---@return MODERATOR +---@return 8 inviteStatus +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---@return 5 +---@return 6 +---@return 7 +---@return 8 +---@return string invitedBy +---@return 2 difficulty +---@return 1 +---@return 2 +---@return 2 inviteType +---@return 1 +---@return 2 +---Returns information about a calendar event on a given day. Information can only be retrieved for events which might be visible in the calendar's current month -- i.e. those in the current month as well as those in (roughly) the last week of the previous month and (roughly) the first two weeks of the following month. To reliably retrieve information for events outside the calendar's current month, first change the calendar's month with CalendarSetMonth. +function CalendarGetDayEvent(monthOffset, -1, 0, 1, day, index) end \ No newline at end of file diff --git a/api/CalendarGetDayEventSequenceInfo.lua b/api/CalendarGetDayEventSequenceInfo.lua new file mode 100644 index 0000000..7118928 --- /dev/null +++ b/api/CalendarGetDayEventSequenceInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CalendarGetDayEventSequenceInfo() end \ No newline at end of file diff --git a/api/CalendarGetEventIndex.lua b/api/CalendarGetEventIndex.lua new file mode 100644 index 0000000..41fd7a8 --- /dev/null +++ b/api/CalendarGetEventIndex.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1 monthOffset +---@return -1 +---@return 0 +---@return 1 +---@return number day +---@return number index +---Returns the month, day, and index of the selected calendar event +function CalendarGetEventIndex() end \ No newline at end of file diff --git a/api/CalendarGetEventInfo.lua b/api/CalendarGetEventInfo.lua new file mode 100644 index 0000000..0aac0be --- /dev/null +++ b/api/CalendarGetEventInfo.lua @@ -0,0 +1,48 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string title +---@return string description +---@return string creator +---@return 5 eventType +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---@return 5 +---@return number repeatOption +---@return number maxSize +---@return number textureIndex +---@return number weekday +---@return number month +---@return number day +---@return number year +---@return number hour +---@return number minute +---@return number lockoutWeekday +---@return number lockoutMonth +---@return number lockoutDay +---@return number lockoutYear +---@return number lockoutHour +---@return number lockoutMinute +---@return 1nil locked +---@return 1nil autoApprove +---@return 1nil pendingInvite +---@return 8 inviteStatus +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---@return 5 +---@return 6 +---@return 7 +---@return 8 +---@return 2 inviteType +---@return 1 +---@return 2 +---@return SYSTEM calendarType +---@return GUILD_ANNOUNCEMENT +---@return GUILD_EVENT +---@return PLAYER +---@return SYSTEM +---Returns information about the selected calendar event +function CalendarGetEventInfo() end \ No newline at end of file diff --git a/api/CalendarGetFirstPendingInvite.lua b/api/CalendarGetFirstPendingInvite.lua new file mode 100644 index 0000000..954b3d5 --- /dev/null +++ b/api/CalendarGetFirstPendingInvite.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param monthOffset number +---@param day number +---@return number index +---Returns the index of the first invitation on a given day to which the player has not responded +function CalendarGetFirstPendingInvite(monthOffset, day) end \ No newline at end of file diff --git a/api/CalendarGetGuildEventInfo.lua b/api/CalendarGetGuildEventInfo.lua new file mode 100644 index 0000000..503fd26 --- /dev/null +++ b/api/CalendarGetGuildEventInfo.lua @@ -0,0 +1,41 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param eventIndex number +---@return 12 month +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---@return 5 +---@return 6 +---@return 7 +---@return 8 +---@return 9 +---@return 10 +---@return 11 +---@return 12 +---@return number day +---@return 7 weekday +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---@return 5 +---@return 6 +---@return 7 +---@return number hour +---@return number minute +---@return 6 eventType +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---@return 5 +---@return 6 +---@return string title +---@return GUILD_EVENT calendarType +---@return GUILD_ANNOUNCEMENT +---@return GUILD_EVENT +---@return string textureName +---Returns information about a calendar guild-event +function CalendarGetGuildEventInfo(eventIndex) end \ No newline at end of file diff --git a/api/CalendarGetGuildEventSelectionInfo.lua b/api/CalendarGetGuildEventSelectionInfo.lua new file mode 100644 index 0000000..efee35d --- /dev/null +++ b/api/CalendarGetGuildEventSelectionInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CalendarGetGuildEventSelectionInfo() end \ No newline at end of file diff --git a/api/CalendarGetHolidayInfo.lua b/api/CalendarGetHolidayInfo.lua new file mode 100644 index 0000000..19cd158 --- /dev/null +++ b/api/CalendarGetHolidayInfo.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param monthOffset number +---@param day number +---@param index number +---@return string name +---@return string description +---@return string texture +---Returns additional information about a holiday event. Information can only be retrieved for events which might be visible in the calendar's current month -- i.e. those in the current month as well as those in (roughly) the last week of the previous month and (roughly) the first two weeks of the following month. To reliably retrieve information for events outside the calendar's current month, first change the calendar's month with CalendarSetMonth. +function CalendarGetHolidayInfo(monthOffset, day, index) end \ No newline at end of file diff --git a/api/CalendarGetMaxCreateDate.lua b/api/CalendarGetMaxCreateDate.lua new file mode 100644 index 0000000..69f1eca --- /dev/null +++ b/api/CalendarGetMaxCreateDate.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number weekday +---@return number month +---@return number day +---@return number year +---Returns the latest date for which events may be scheduled. Currently, events can only be created up to one year from the last day of the current month (e.g. If the current date is May 19, 2009, the player is not allowed to create events scheduled for later than May 31, 2010). The default Calendar UI also does not allow viewing months beyond this date. +function CalendarGetMaxCreateDate() end \ No newline at end of file diff --git a/api/CalendarGetMaxDate.lua b/api/CalendarGetMaxDate.lua new file mode 100644 index 0000000..47fcc3c --- /dev/null +++ b/api/CalendarGetMaxDate.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number weekday +---@return number month +---@return number day +---@return number year +---Returns the latest date usable in the calendar system. This function currently always returns December 31st, 2030 as the max date. +function CalendarGetMaxDate() end \ No newline at end of file diff --git a/api/CalendarGetMinDate.lua b/api/CalendarGetMinDate.lua new file mode 100644 index 0000000..c8d36e7 --- /dev/null +++ b/api/CalendarGetMinDate.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number weekday +---@return number month +---@return number day +---@return number year +---Returns the earliest date usable in the calendar system. This function currently returns November 24th, 2004 as the minimum date. This is the date that World of Warcraft was launched in the U.S. +function CalendarGetMinDate() end \ No newline at end of file diff --git a/api/CalendarGetMinHistoryDate.lua b/api/CalendarGetMinHistoryDate.lua new file mode 100644 index 0000000..6cf48d5 --- /dev/null +++ b/api/CalendarGetMinHistoryDate.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number weekday +---@return number month +---@return number day +---@return number year +---Returns the earliest date for which information about past player events is available. Applies to events created by the player, invites the player accepted, and guild events or announcements. Currently, the default UI only shows past events from up to two weeks before the current date. +function CalendarGetMinHistoryDate() end \ No newline at end of file diff --git a/api/CalendarGetMonth.lua b/api/CalendarGetMonth.lua new file mode 100644 index 0000000..d418cbf --- /dev/null +++ b/api/CalendarGetMonth.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param monthOffset number +---@return number month +---@return number year +---@return number numDays +---@return number firstWeekday +---Returns information about a calendar month +function CalendarGetMonth(monthOffset) end \ No newline at end of file diff --git a/api/CalendarGetMonthNames.lua b/api/CalendarGetMonthNames.lua new file mode 100644 index 0000000..88300a5 --- /dev/null +++ b/api/CalendarGetMonthNames.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return list ... +---Returns a list of localized month names +function CalendarGetMonthNames() end \ No newline at end of file diff --git a/api/CalendarGetNumDayEvents.lua b/api/CalendarGetNumDayEvents.lua new file mode 100644 index 0000000..5086299 --- /dev/null +++ b/api/CalendarGetNumDayEvents.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param monthOffset number +---@param day number +---@return number numEvents +---Returns the number of calendar events on a given day +function CalendarGetNumDayEvents(monthOffset, day) end \ No newline at end of file diff --git a/api/CalendarGetNumGuildEvents.lua b/api/CalendarGetNumGuildEvents.lua new file mode 100644 index 0000000..56653be --- /dev/null +++ b/api/CalendarGetNumGuildEvents.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numEvents +---Returns the number of guild events in your calendar +function CalendarGetNumGuildEvents() end \ No newline at end of file diff --git a/api/CalendarGetNumPendingInvites.lua b/api/CalendarGetNumPendingInvites.lua new file mode 100644 index 0000000..ab90d96 --- /dev/null +++ b/api/CalendarGetNumPendingInvites.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numInvites +---Returns the number of calendar invitations to which the player has yet to respond +function CalendarGetNumPendingInvites() end \ No newline at end of file diff --git a/api/CalendarGetRaidInfo.lua b/api/CalendarGetRaidInfo.lua new file mode 100644 index 0000000..79df0dc --- /dev/null +++ b/api/CalendarGetRaidInfo.lua @@ -0,0 +1,17 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param monthOffset number +---@param day number +---@param index number +---@return number title +---@return RAID_RESET calendarType +---@return RAID_LOCKOUT +---@return RAID_RESET +---@return number raidID +---@return number hour +---@return number minute +---@return 2 difficulty +---@return 1 +---@return 2 +---Returns information about a raid lockout or scheduled raid reset event. Information can only be retrieved for events which might be visible in the calendar's current month -- i.e. those in the current month as well as those in (roughly) the last week of the previous month and (roughly) the first two weeks of the following month. To reliably retrieve information for events outside the calendar's current month, first change the calendar's month with CalendarSetMonth. +function CalendarGetRaidInfo(monthOffset, day, index) end \ No newline at end of file diff --git a/api/CalendarGetWeekdayNames.lua b/api/CalendarGetWeekdayNames.lua new file mode 100644 index 0000000..93c4e6e --- /dev/null +++ b/api/CalendarGetWeekdayNames.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return list ... +---Returns a list of localized weekday names +function CalendarGetWeekdayNames() end \ No newline at end of file diff --git a/api/CalendarIsActionPending.lua b/api/CalendarIsActionPending.lua new file mode 100644 index 0000000..286a803 --- /dev/null +++ b/api/CalendarIsActionPending.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean isPending +---Returns whether an update to calendar information is in progress. Returns true while the client is synchronizing its calendar information from the server; e.g. after calling CalendarOpenEvent, CalendarAddEvent, or CalendarUpdateEvent. During such periods, using other calendar API functions to query or change event information may not have valid orexpected results. +function CalendarIsActionPending() end \ No newline at end of file diff --git a/api/CalendarMassInviteGuild.lua b/api/CalendarMassInviteGuild.lua new file mode 100644 index 0000000..00d4c62 --- /dev/null +++ b/api/CalendarMassInviteGuild.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param minLevel number +---@param maxLevel number +---@param rank number +---Repopulates the selected event's invite list with members of the player's guild. Clears any invites already listed. Can only be used for events not yet created (i.e. saved to the calendar). +function CalendarMassInviteGuild(minLevel, maxLevel, rank) end \ No newline at end of file diff --git a/api/CalendarNewEvent.lua b/api/CalendarNewEvent.lua new file mode 100644 index 0000000..832b492 --- /dev/null +++ b/api/CalendarNewEvent.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Creates a new event and selects it for viewing/editing +function CalendarNewEvent() end \ No newline at end of file diff --git a/api/CalendarNewGuildAnnouncement.lua b/api/CalendarNewGuildAnnouncement.lua new file mode 100644 index 0000000..67ab1f2 --- /dev/null +++ b/api/CalendarNewGuildAnnouncement.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Creates a new guild announcement and selects it for viewing/editing. Guild announcements are visible to all guild members but do not allow signups or invitations. +function CalendarNewGuildAnnouncement() end \ No newline at end of file diff --git a/api/CalendarNewGuildEvent.lua b/api/CalendarNewGuildEvent.lua new file mode 100644 index 0000000..4edd13e --- /dev/null +++ b/api/CalendarNewGuildEvent.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Creates a new guild event and selects it for viewing/editing. Guild events are visible to all guild members and allow members to sign up (or non-members to be invited). +function CalendarNewGuildEvent() end \ No newline at end of file diff --git a/api/CalendarOpenEvent.lua b/api/CalendarOpenEvent.lua new file mode 100644 index 0000000..9d1bffb --- /dev/null +++ b/api/CalendarOpenEvent.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param monthOffset number +---@param day number +---@param index number +---Selects a calendar event for viewing/editing +function CalendarOpenEvent(monthOffset, day, index) end \ No newline at end of file diff --git a/api/CalendarRemoveEvent.lua b/api/CalendarRemoveEvent.lua new file mode 100644 index 0000000..77f8c05 --- /dev/null +++ b/api/CalendarRemoveEvent.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Removes the selected event invitation from the player's calendar or removes the player from the selected guild event's signup list. NOTE: May disconnect the player if called when the selected calendar event is not a received invitation or a guild event. +function CalendarRemoveEvent() end \ No newline at end of file diff --git a/api/CalendarSetAbsMonth.lua b/api/CalendarSetAbsMonth.lua new file mode 100644 index 0000000..d55dc88 --- /dev/null +++ b/api/CalendarSetAbsMonth.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param month number +---@param year number +---Set's the calendar's month to an absolute date +function CalendarSetAbsMonth(month, year) end \ No newline at end of file diff --git a/api/CalendarSetMonth.lua b/api/CalendarSetMonth.lua new file mode 100644 index 0000000..a914cc0 --- /dev/null +++ b/api/CalendarSetMonth.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param monthOffset 1 +---@param -1 +---@param 0 +---@param 1 +---Sets the calendar's month relative to its current month +function CalendarSetMonth(monthOffset, -1, 0, 1) end \ No newline at end of file diff --git a/api/CalendarUpdateEvent.lua b/api/CalendarUpdateEvent.lua new file mode 100644 index 0000000..f476d4f --- /dev/null +++ b/api/CalendarUpdateEvent.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Saves changes made to the selected event. Until this function is called, changes made to an event will not be saved -- they will not propagate to guild members or invitees, and the event will revert to its previous state if the player closes the calendar, reloads the UI, or goes to view or edit another event. Only applies to existing events; for newly created events use CalendarAddEvent() once the event's attributes and initial invite list are set. +function CalendarUpdateEvent() end \ No newline at end of file diff --git a/api/CallCompanion.lua b/api/CallCompanion.lua new file mode 100644 index 0000000..f82e396 --- /dev/null +++ b/api/CallCompanion.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param type MOUNT +---@param CRITTER +---@param MOUNT +---@param index number +---Summons a non-combat pet or mount. If called referencing the current non-combat pet, dismisses it. Does nothing if given an index greater than GetNumCompanions(type). +function CallCompanion(type, CRITTER, MOUNT, index) end \ No newline at end of file diff --git a/api/CameraOrSelectOrMoveStart.lua b/api/CameraOrSelectOrMoveStart.lua new file mode 100644 index 0000000..2b5ebc8 --- /dev/null +++ b/api/CameraOrSelectOrMoveStart.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Begins camera movement or selection (equivalent to left-clicking in the 3-D world). After calling this function (i.e. while the left mouse button is held), cursor movement rotates the camera. Final results vary by context and are determined when calling CameraOrSelectOrMoveStop() (i.e. releasing the left mouse button). Used by the CAMERAORSELECTORMOVE binding (not customizable in the default UI), which is bound to the left mouse button by default. +function CameraOrSelectOrMoveStart() end \ No newline at end of file diff --git a/api/CameraOrSelectOrMoveStop.lua b/api/CameraOrSelectOrMoveStop.lua new file mode 100644 index 0000000..3bada9c --- /dev/null +++ b/api/CameraOrSelectOrMoveStop.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param isSticky 1nil +---Ends action initiated by CameraOrSelectOrMoveStart. After calling this function (i.e. releasing the left mouse button), camera movement stops and normal cursor movement resumes. If the cursor has not moved significantly since calling CameraOrSelectOrMoveStart() (i.e. pressing the left mouse button) and is over a unit, that unit becomes the player's target; if the cursor has not moved significantly and is not over a unit, clears the player's target unless the "Sticky Targeting" option is enabled (i.e. the "deselectOnClick" CVar is 0). Used by the CAMERAORSELECTORMOVE binding (not customizable in the default UI), which is bound to the left mouse button by default. +function CameraOrSelectOrMoveStop(isSticky) end \ No newline at end of file diff --git a/api/CameraZoomIn.lua b/api/CameraZoomIn.lua new file mode 100644 index 0000000..876752a --- /dev/null +++ b/api/CameraZoomIn.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param distance number +---Zooms the camera in by a specified distance. The max distance of the camera is set in the Interface Options screen, and the maximum distance allowed is enforced by this setting, and the game client. Depending on the setting, this is between 15.0 and 24.0 in the current version of the client. +function CameraZoomIn(distance) end \ No newline at end of file diff --git a/api/CameraZoomOut.lua b/api/CameraZoomOut.lua new file mode 100644 index 0000000..b9cde56 --- /dev/null +++ b/api/CameraZoomOut.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param distance number +---Zooms the camera out by a specified distance. This function is used to zoom the camera out. The max distance of the camera is set in the Interface Options screen, and the maximum distance allowed is enforced by this setting, and the game client. Depending on the setting, this is between 15.0 and 24.0 in the current version of the client. +function CameraZoomOut(distance) end \ No newline at end of file diff --git a/api/CanAbandonQuest.lua b/api/CanAbandonQuest.lua new file mode 100644 index 0000000..4285165 --- /dev/null +++ b/api/CanAbandonQuest.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param questID number +---@return boolean CanAbandon +---Returns info about whether a quest with a given ID can be abandoned +function CanAbandonQuest(questID) end \ No newline at end of file diff --git a/api/CanAlterSkin.lua b/api/CanAlterSkin.lua new file mode 100644 index 0000000..10b41ab --- /dev/null +++ b/api/CanAlterSkin.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean canAlter +---Lets you check if the player can change their skin color. Returns true if the player can change their skin color while using the barbershop. +function CanAlterSkin() end \ No newline at end of file diff --git a/api/CanBeRaidTarget.lua b/api/CanBeRaidTarget.lua new file mode 100644 index 0000000..50d14ab --- /dev/null +++ b/api/CanBeRaidTarget.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return boolean canMark +---Returns whether a unit can be marked with a raid symbol or not +function CanBeRaidTarget(unit) end \ No newline at end of file diff --git a/api/CanCancelAuction.lua b/api/CanCancelAuction.lua new file mode 100644 index 0000000..6b54b91 --- /dev/null +++ b/api/CanCancelAuction.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return 1nil canCancel +---Returns whether one of the player's auctions can be canceled. Generally, non-cancelable auctions are those which have completed but for which payment has not yet been delivered. +function CanCancelAuction(index) end \ No newline at end of file diff --git a/api/CanComplainChat.lua b/api/CanComplainChat.lua new file mode 100644 index 0000000..0910c86 --- /dev/null +++ b/api/CanComplainChat.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param lineID number +---@return 1nil canComplain +---Returns whether a chat message can be reported as spam +function CanComplainChat(lineID) end \ No newline at end of file diff --git a/api/CanComplainInboxItem.lua b/api/CanComplainInboxItem.lua new file mode 100644 index 0000000..adf5362 --- /dev/null +++ b/api/CanComplainInboxItem.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param mailID number +---@return 1nil complain +---Returns whether a mail can be reported as spam. Returns nil for messages from Game Masters or friends, as well as for messages generated by the game itself (Auction House mail, mails from NPCs, etc). As with most mail functions, only provides valid information if used while the mail UI is open (between the MAIL_SHOW and MAIL_CLOSE events). +function CanComplainInboxItem(mailID) end \ No newline at end of file diff --git a/api/CanEditGuildBankTabInfo.lua b/api/CanEditGuildBankTabInfo.lua new file mode 100644 index 0000000..f56bff4 --- /dev/null +++ b/api/CanEditGuildBankTabInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CanEditGuildBankTabInfo() end \ No newline at end of file diff --git a/api/CanEditGuildEvent.lua b/api/CanEditGuildEvent.lua new file mode 100644 index 0000000..78f88ed --- /dev/null +++ b/api/CanEditGuildEvent.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil canEdit +---Returns whether the player is allowed to edit guild-wide calendar events +function CanEditGuildEvent() end \ No newline at end of file diff --git a/api/CanEditGuildInfo.lua b/api/CanEditGuildInfo.lua new file mode 100644 index 0000000..2e07df1 --- /dev/null +++ b/api/CanEditGuildInfo.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil canEdit +---Returns whether the player is allowed to edit the guild information text. This text appears when clicking the "Guild Information" button in the default UI's Guild window. +function CanEditGuildInfo() end \ No newline at end of file diff --git a/api/CanEditGuildTabInfo.lua b/api/CanEditGuildTabInfo.lua new file mode 100644 index 0000000..b2c385b --- /dev/null +++ b/api/CanEditGuildTabInfo.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param tab number +---@return 1nil canEdit +---Returns whether the player is allowed to edit a guild bank tab's information +function CanEditGuildTabInfo(tab) end \ No newline at end of file diff --git a/api/CanEditMOTD.lua b/api/CanEditMOTD.lua new file mode 100644 index 0000000..a79bd45 --- /dev/null +++ b/api/CanEditMOTD.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil canEdit +---Returns whether the player is allowed to edit the guild Message of the Day +function CanEditMOTD() end \ No newline at end of file diff --git a/api/CanEditOfficerNote.lua b/api/CanEditOfficerNote.lua new file mode 100644 index 0000000..34b3279 --- /dev/null +++ b/api/CanEditOfficerNote.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil canEdit +---Returns whether the player is allowed to edit guild officer notes +function CanEditOfficerNote() end \ No newline at end of file diff --git a/api/CanEditPublicNote.lua b/api/CanEditPublicNote.lua new file mode 100644 index 0000000..3b669bc --- /dev/null +++ b/api/CanEditPublicNote.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil canEdit +---Returns whether the player is allowed to edit guild public notes +function CanEditPublicNote() end \ No newline at end of file diff --git a/api/CanEjectPassengerFromSeat.lua b/api/CanEjectPassengerFromSeat.lua new file mode 100644 index 0000000..71c6868 --- /dev/null +++ b/api/CanEjectPassengerFromSeat.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param seat number +---@return boolean canEject +---Returns whether the player can eject the occupant of a seat in the player's vehicle +function CanEjectPassengerFromSeat(seat) end \ No newline at end of file diff --git a/api/CanExitVehicle.lua b/api/CanExitVehicle.lua new file mode 100644 index 0000000..be6fb5b --- /dev/null +++ b/api/CanExitVehicle.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil canExit +---Returns whether the player is in a vehicle. Used in the default UI to determine whether to show the "Leave Vehicle" button while controlling siege vehicles, turrets, and certain special mounts and quest entities. +function CanExitVehicle() end \ No newline at end of file diff --git a/api/CanGrantLevel.lua b/api/CanGrantLevel.lua new file mode 100644 index 0000000..7b16436 --- /dev/null +++ b/api/CanGrantLevel.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return 1nil canGrant +---Returns whether the player can give levels to a Recruit-a-Friend partner +function CanGrantLevel(unit) end \ No newline at end of file diff --git a/api/CanGuildBankRepair.lua b/api/CanGuildBankRepair.lua new file mode 100644 index 0000000..0272c58 --- /dev/null +++ b/api/CanGuildBankRepair.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil canRepair +---Returns whether the player is allowed to pay for repairs using guild bank funds +function CanGuildBankRepair() end \ No newline at end of file diff --git a/api/CanGuildDemote.lua b/api/CanGuildDemote.lua new file mode 100644 index 0000000..b517bdc --- /dev/null +++ b/api/CanGuildDemote.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil canDemote +---Returns whether the player is allowed to demote lower ranked guild members +function CanGuildDemote() end \ No newline at end of file diff --git a/api/CanGuildInvite.lua b/api/CanGuildInvite.lua new file mode 100644 index 0000000..93e247a --- /dev/null +++ b/api/CanGuildInvite.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil canInvite +---Returns whether the player is allowed to invite new members to his or her guild +function CanGuildInvite() end \ No newline at end of file diff --git a/api/CanGuildPromote.lua b/api/CanGuildPromote.lua new file mode 100644 index 0000000..86ec641 --- /dev/null +++ b/api/CanGuildPromote.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil canPromote +---Returns whether the player is allowed to promote other guild members. The player may promote other members only up to the rank below his or her own. +function CanGuildPromote() end \ No newline at end of file diff --git a/api/CanGuildRemove.lua b/api/CanGuildRemove.lua new file mode 100644 index 0000000..365eb38 --- /dev/null +++ b/api/CanGuildRemove.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil canRemove +---Returns whether the player is allowed to remove members from his or her guild. The player may only remove lower ranked members from the guild. +function CanGuildRemove() end \ No newline at end of file diff --git a/api/CanHearthAndResurrectFromArea.lua b/api/CanHearthAndResurrectFromArea.lua new file mode 100644 index 0000000..2cdeec5 --- /dev/null +++ b/api/CanHearthAndResurrectFromArea.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil status +---Returns whether the player is in a world PvP zone offering an exit option. Used by the default UI to show the MiniMapBattlefieldFrame and provide a menu option for leaving if the player is in a world PvP combat zone (i.e. Wintergrasp). +function CanHearthAndResurrectFromArea() end \ No newline at end of file diff --git a/api/CanInitiateWarGame.lua b/api/CanInitiateWarGame.lua new file mode 100644 index 0000000..5235081 --- /dev/null +++ b/api/CanInitiateWarGame.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CanInitiateWarGame() end \ No newline at end of file diff --git a/api/CanInspect.lua b/api/CanInspect.lua new file mode 100644 index 0000000..4669f65 --- /dev/null +++ b/api/CanInspect.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param showError boolean +---@return 1nil canInspect +---Returns whether a unit can be inspected. Returns nil if the unit is out of inspect range, if the unit is an NPC, or if the unit is flagged for PvP combat and hostile to the player. +function CanInspect(unit, showError) end \ No newline at end of file diff --git a/api/CanItemBeSocketedToArtifact.lua b/api/CanItemBeSocketedToArtifact.lua new file mode 100644 index 0000000..d7cbd92 --- /dev/null +++ b/api/CanItemBeSocketedToArtifact.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CanItemBeSocketedToArtifact() end \ No newline at end of file diff --git a/api/CanJoinBattlefieldAsGroup.lua b/api/CanJoinBattlefieldAsGroup.lua new file mode 100644 index 0000000..a39f5f3 --- /dev/null +++ b/api/CanJoinBattlefieldAsGroup.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil canGroupJoin +---Returns whether the battleground for which the player is queueing supports joining as a group +function CanJoinBattlefieldAsGroup() end \ No newline at end of file diff --git a/api/CanLootUnit.lua b/api/CanLootUnit.lua new file mode 100644 index 0000000..ec60e7e --- /dev/null +++ b/api/CanLootUnit.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CanLootUnit() end \ No newline at end of file diff --git a/api/CanMapChangeDifficulty.lua b/api/CanMapChangeDifficulty.lua new file mode 100644 index 0000000..3d20093 --- /dev/null +++ b/api/CanMapChangeDifficulty.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CanMapChangeDifficulty() end \ No newline at end of file diff --git a/api/CanMerchantRepair.lua b/api/CanMerchantRepair.lua new file mode 100644 index 0000000..355ac9e --- /dev/null +++ b/api/CanMerchantRepair.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil canRepair +---Returns whether the vendor with whom the player is currently interacting can repair equipment +function CanMerchantRepair() end \ No newline at end of file diff --git a/api/CanPartyLFGBackfill.lua b/api/CanPartyLFGBackfill.lua new file mode 100644 index 0000000..3d8a7f6 --- /dev/null +++ b/api/CanPartyLFGBackfill.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CanPartyLFGBackfill() end \ No newline at end of file diff --git a/api/CanQueueForWintergrasp.lua b/api/CanQueueForWintergrasp.lua new file mode 100644 index 0000000..e72ab55 --- /dev/null +++ b/api/CanQueueForWintergrasp.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean canQueue +---Returns whether the player can queue for Wintergrasp +function CanQueueForWintergrasp() end \ No newline at end of file diff --git a/api/CanReplaceGuildMaster.lua b/api/CanReplaceGuildMaster.lua new file mode 100644 index 0000000..2bf855b --- /dev/null +++ b/api/CanReplaceGuildMaster.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CanReplaceGuildMaster() end \ No newline at end of file diff --git a/api/CanResetTutorials.lua b/api/CanResetTutorials.lua new file mode 100644 index 0000000..83dc4ef --- /dev/null +++ b/api/CanResetTutorials.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CanResetTutorials() end \ No newline at end of file diff --git a/api/CanSendAuctionQuery.lua b/api/CanSendAuctionQuery.lua new file mode 100644 index 0000000..a9ec40e --- /dev/null +++ b/api/CanSendAuctionQuery.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param list owner +---@param bidder +---@param list +---@param owner +---@return 1nil canQuery +---@return 1nil canMassQuery +---Returns whether the player can perform an auction house query. All auction query types are throttled, preventing abuse of the server by clients sending too many queries in short succession. Normal queries can be sent once every few seconds; mass queries return all results in the auction house instead of one "page" at a time, and can only be sent once every several minutes. +function CanSendAuctionQuery(list, bidder, list, owner) end \ No newline at end of file diff --git a/api/CanShowAchievementUI.lua b/api/CanShowAchievementUI.lua new file mode 100644 index 0000000..b59f5df --- /dev/null +++ b/api/CanShowAchievementUI.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean canShow +---Returns whether the Achievements UI should be enabled. Used by the default UI to determine whether to show or hide the menu button for Achievements (as it also does for Talents); currently always returns true. +function CanShowAchievementUI() end \ No newline at end of file diff --git a/api/CanShowResetInstances.lua b/api/CanShowResetInstances.lua new file mode 100644 index 0000000..e2b863c --- /dev/null +++ b/api/CanShowResetInstances.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil canResetInstances +---Returns whether the player can reset instances. Used to determine whether to display the "Reset Instance" option in the unit popup menu for the player. Only instances to which the player is not saved may be reset (i.e. normal 5-man dungeons, not heroic dungeons or raids), and only by a solo player or group leader. +function CanShowResetInstances() end \ No newline at end of file diff --git a/api/CanSignPetition.lua b/api/CanSignPetition.lua new file mode 100644 index 0000000..d383f96 --- /dev/null +++ b/api/CanSignPetition.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil canSign +---Returns whether the player can sign the currently offered petition. Petitions can only be signed once per account, rather than once per character. +function CanSignPetition() end \ No newline at end of file diff --git a/api/CanSolveArtifact.lua b/api/CanSolveArtifact.lua new file mode 100644 index 0000000..359487a --- /dev/null +++ b/api/CanSolveArtifact.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil canSolve +---Returns whether the player can solve the selected artifact. +function CanSolveArtifact() end \ No newline at end of file diff --git a/api/CanSummonFriend.lua b/api/CanSummonFriend.lua new file mode 100644 index 0000000..74dc5a6 --- /dev/null +++ b/api/CanSummonFriend.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param unit string +---@return 1nil canSummon +---Returns whether a unit can be summoned via Recruit-a-Friend. Indicates whether the target unit is currently summonable, not just whether that unit's account is linked to the player's via the Recruit-A-Friend program. +function CanSummonFriend(name, unit) end \ No newline at end of file diff --git a/api/CanSwitchVehicleSeat.lua b/api/CanSwitchVehicleSeat.lua new file mode 100644 index 0000000..efd0e1b --- /dev/null +++ b/api/CanSwitchVehicleSeat.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean canSwitch +---Returns whether the player can change vehicle seats. Tells you if the player can switch seats in general, whereas UnitVehicleSeatInfo() tells you if the player can switch into a specific seat. +function CanSwitchVehicleSeat() end \ No newline at end of file diff --git a/api/CanSwitchVehicleSeats.lua b/api/CanSwitchVehicleSeats.lua new file mode 100644 index 0000000..06cd401 --- /dev/null +++ b/api/CanSwitchVehicleSeats.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil canSwitch +---Returns whether the player is in a vehicle with multiple seats +function CanSwitchVehicleSeats() end \ No newline at end of file diff --git a/api/CanTrackBattlePets.lua b/api/CanTrackBattlePets.lua new file mode 100644 index 0000000..e2febb7 --- /dev/null +++ b/api/CanTrackBattlePets.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CanTrackBattlePets() end \ No newline at end of file diff --git a/api/CanTransmogrifyItemWithItem.lua b/api/CanTransmogrifyItemWithItem.lua new file mode 100644 index 0000000..90880f6 --- /dev/null +++ b/api/CanTransmogrifyItemWithItem.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CanTransmogrifyItemWithItem() end \ No newline at end of file diff --git a/api/CanUpgradeExpansion.lua b/api/CanUpgradeExpansion.lua new file mode 100644 index 0000000..fbf9066 --- /dev/null +++ b/api/CanUpgradeExpansion.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Returns true if the user is not on the latest expansion +function CanUpgradeExpansion() end \ No newline at end of file diff --git a/api/CanUseEquipmentSets.lua b/api/CanUseEquipmentSets.lua new file mode 100644 index 0000000..8fe87d4 --- /dev/null +++ b/api/CanUseEquipmentSets.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean enabled +---Returns whether the player has enabled the equipment manager. Despite the name, this returns true when the player has enabled the use of the equipment manager through the interface or CVars. +function CanUseEquipmentSets() end \ No newline at end of file diff --git a/api/CanUseVoidStorage.lua b/api/CanUseVoidStorage.lua new file mode 100644 index 0000000..20166c3 --- /dev/null +++ b/api/CanUseVoidStorage.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CanUseVoidStorage() end \ No newline at end of file diff --git a/api/CanViewGuildRecipes.lua b/api/CanViewGuildRecipes.lua new file mode 100644 index 0000000..bb2722e --- /dev/null +++ b/api/CanViewGuildRecipes.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CanViewGuildRecipes() end \ No newline at end of file diff --git a/api/CanViewOfficerNote.lua b/api/CanViewOfficerNote.lua new file mode 100644 index 0000000..8a42ec4 --- /dev/null +++ b/api/CanViewOfficerNote.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil canView +---Returns whether the player is allowed to view guild officer notes +function CanViewOfficerNote() end \ No newline at end of file diff --git a/api/CanWithdrawGuildBankMoney.lua b/api/CanWithdrawGuildBankMoney.lua new file mode 100644 index 0000000..e0e42a2 --- /dev/null +++ b/api/CanWithdrawGuildBankMoney.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil canWithdraw +---Returns whether the player is allowed to withdraw money from the guild bank +function CanWithdrawGuildBankMoney() end \ No newline at end of file diff --git a/api/CancelAreaSpiritHeal.lua b/api/CancelAreaSpiritHeal.lua new file mode 100644 index 0000000..2451d07 --- /dev/null +++ b/api/CancelAreaSpiritHeal.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Declines the next upcoming periodic resurrection from a battleground spirit healer. Usable in response to the AREA_SPIRIT_HEALER_IN_RANGE event which fires when the player's ghost is near a battleground spirit healer. +function CancelAreaSpiritHeal() end \ No newline at end of file diff --git a/api/CancelAuction.lua b/api/CancelAuction.lua new file mode 100644 index 0000000..ab8acdd --- /dev/null +++ b/api/CancelAuction.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Cancels an auction created by the player. When canceling an auction, the deposit amount is not refunded. +function CancelAuction(index) end \ No newline at end of file diff --git a/api/CancelBarberShop.lua b/api/CancelBarberShop.lua new file mode 100644 index 0000000..4342246 --- /dev/null +++ b/api/CancelBarberShop.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Exits a barber shop session. Causes the player character to stand up, returning to the normal world, and fires the BARBER_SHOP_CLOSE event. Any style changes already paid for (with ApplyBarberShopStyle()) are kept; any changes since are discarded. +function CancelBarberShop() end \ No newline at end of file diff --git a/api/CancelDuel.lua b/api/CancelDuel.lua new file mode 100644 index 0000000..32353a9 --- /dev/null +++ b/api/CancelDuel.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Cancels an ongoing duel, or declines an offered duel +function CancelDuel() end \ No newline at end of file diff --git a/api/CancelEmote.lua b/api/CancelEmote.lua new file mode 100644 index 0000000..1c26820 --- /dev/null +++ b/api/CancelEmote.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CancelEmote() end \ No newline at end of file diff --git a/api/CancelGuildMembershipRequest.lua b/api/CancelGuildMembershipRequest.lua new file mode 100644 index 0000000..06ec989 --- /dev/null +++ b/api/CancelGuildMembershipRequest.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CancelGuildMembershipRequest() end \ No newline at end of file diff --git a/api/CancelItemTempEnchantment.lua b/api/CancelItemTempEnchantment.lua new file mode 100644 index 0000000..ea7bc05 --- /dev/null +++ b/api/CancelItemTempEnchantment.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---Cancels a temporary weapon enchant. Examples of temporary enchants include mana oils, sharpening stones, and Shaman weapon enhancements. +function CancelItemTempEnchantment(slot) end \ No newline at end of file diff --git a/api/CancelLogout.lua b/api/CancelLogout.lua new file mode 100644 index 0000000..406f852 --- /dev/null +++ b/api/CancelLogout.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Cancels a pending logout or quit. Only has effect if logout or quit is pending (following the PLAYER_CAMPING or PLAYER_QUITING event). +function CancelLogout() end \ No newline at end of file diff --git a/api/CancelMasterLootRoll.lua b/api/CancelMasterLootRoll.lua new file mode 100644 index 0000000..b01f6e7 --- /dev/null +++ b/api/CancelMasterLootRoll.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CancelMasterLootRoll() end \ No newline at end of file diff --git a/api/CancelPendingEquip.lua b/api/CancelPendingEquip.lua new file mode 100644 index 0000000..2b1f84e --- /dev/null +++ b/api/CancelPendingEquip.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Cancels equipping a bind-on-equip item. When the player attempts to equip a bind-on-equip item, the default UI displays a dialog warning that equipping the item will cause it to become soulbound; this function is called when canceling that dialog. +function CancelPendingEquip(index) end \ No newline at end of file diff --git a/api/CancelPreloadingMovie.lua b/api/CancelPreloadingMovie.lua new file mode 100644 index 0000000..c856404 --- /dev/null +++ b/api/CancelPreloadingMovie.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CancelPreloadingMovie() end \ No newline at end of file diff --git a/api/CancelSell.lua b/api/CancelSell.lua new file mode 100644 index 0000000..5025916 --- /dev/null +++ b/api/CancelSell.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CancelSell() end \ No newline at end of file diff --git a/api/CancelShapeshiftForm.lua b/api/CancelShapeshiftForm.lua new file mode 100644 index 0000000..bbd4d9b --- /dev/null +++ b/api/CancelShapeshiftForm.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Cancels the current shapeshift form. Unlike other Shapeshift APIs, this function refers specifically to shapeshifting -- therefore including some abilities not found on the default UI's ShapeshiftBar and excluding some which are. For example, cancels shaman Ghost Wolf form and druid shapeshifts but not warrior stances, paladin auras, or rogue stealth. +function CancelShapeshiftForm() end \ No newline at end of file diff --git a/api/CancelSummon.lua b/api/CancelSummon.lua new file mode 100644 index 0000000..8d7367f --- /dev/null +++ b/api/CancelSummon.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Declines an offered summons. Usable between when the CONFIRM_SUMMON event fires (due to a summoning spell cast by another player) and when the value returned by GetSummonConfirmTimeLeft() reaches zero. +function CancelSummon() end \ No newline at end of file diff --git a/api/CancelTrade.lua b/api/CancelTrade.lua new file mode 100644 index 0000000..83bddd3 --- /dev/null +++ b/api/CancelTrade.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Cancels a trade in progress. Can be used if either party has accepted the trade, but not once both have. +function CancelTrade() end \ No newline at end of file diff --git a/api/CancelTradeAccept.lua b/api/CancelTradeAccept.lua new file mode 100644 index 0000000..764e366 --- /dev/null +++ b/api/CancelTradeAccept.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Cancels the player's acceptance of a trade. If the player has accepted the trade but the target has not, reverts the player to the pre-acceptance state but does not end the trade. +function CancelTradeAccept() end \ No newline at end of file diff --git a/api/CancelUnitBuff.lua b/api/CancelUnitBuff.lua new file mode 100644 index 0000000..5323aa5 --- /dev/null +++ b/api/CancelUnitBuff.lua @@ -0,0 +1,15 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param index number +---@param name string +---@param rank string +---@param filter RAID +---@param CANCELABLE +---@param HARMFUL +---@param HELPFUL +---@param NOT_CANCELABLE +---@param PLAYER +---@param RAID +---Cancels a buff on the player. CancelUnitBuff becomes a protected function while under combat lockdown. +function CancelUnitBuff(unit, index, name, rank, filter, CANCELABLE, HARMFUL, HELPFUL, NOT_CANCELABLE, PLAYER, RAID) end \ No newline at end of file diff --git a/api/CastGlyph.lua b/api/CastGlyph.lua new file mode 100644 index 0000000..15315e5 --- /dev/null +++ b/api/CastGlyph.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CastGlyph() end \ No newline at end of file diff --git a/api/CastGlyphByID.lua b/api/CastGlyphByID.lua new file mode 100644 index 0000000..08dedec --- /dev/null +++ b/api/CastGlyphByID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CastGlyphByID() end \ No newline at end of file diff --git a/api/CastGlyphByName.lua b/api/CastGlyphByName.lua new file mode 100644 index 0000000..e0b8a40 --- /dev/null +++ b/api/CastGlyphByName.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CastGlyphByName() end \ No newline at end of file diff --git a/api/CastPetAction.lua b/api/CastPetAction.lua new file mode 100644 index 0000000..76115af --- /dev/null +++ b/api/CastPetAction.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param unit string +---Casts a pet action on a specific target +function CastPetAction(index, unit) end \ No newline at end of file diff --git a/api/CastShapeshiftForm.lua b/api/CastShapeshiftForm.lua new file mode 100644 index 0000000..2b9f81f --- /dev/null +++ b/api/CastShapeshiftForm.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Casts an ability on the stance/shapeshift bar +function CastShapeshiftForm(index) end \ No newline at end of file diff --git a/api/CastSpell.lua b/api/CastSpell.lua new file mode 100644 index 0000000..b05b838 --- /dev/null +++ b/api/CastSpell.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@param bookType spell +---@param pet +---@param spell +---Casts a from the spellbook. Only protected (i.e. usable only by the Blizzard UI) if the given id corresponds to a spell which can be cast (not a passive spell) and is not a trade skill; can be used by addons to cast the "spells" that open trade skill windows. +function CastSpell(id, bookType, pet, spell) end \ No newline at end of file diff --git a/api/CastSpellByID.lua b/api/CastSpellByID.lua new file mode 100644 index 0000000..8fec778 --- /dev/null +++ b/api/CastSpellByID.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param spellID number +---@param target string +---Casts a spell specified by id (optionally on a specified unit). Only protected (i.e. usable only by the Blizzard UI) if the given spell is castable (not passive) and is not a trade skill; can be used by addons to cast the "spells" that open trade skill windows. +function CastSpellByID(spellID, target) end \ No newline at end of file diff --git a/api/CastSpellByName.lua b/api/CastSpellByName.lua new file mode 100644 index 0000000..d6acb11 --- /dev/null +++ b/api/CastSpellByName.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param target string +---Casts a spell specified by name (optionally on a specified unit). Only protected (i.e. usable only by the Blizzard UI) if the given spell is castable (not passive) and is not a trade skill; can be used by addons to cast the "spells" that open trade skill windows. +function CastSpellByName(name, target) end \ No newline at end of file diff --git a/api/ChangeActionBarPage.lua b/api/ChangeActionBarPage.lua new file mode 100644 index 0000000..93ea0ce --- /dev/null +++ b/api/ChangeActionBarPage.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param page number +---Changes the current action bar page +function ChangeActionBarPage(page) end \ No newline at end of file diff --git a/api/ChangeChatColor.lua b/api/ChangeChatColor.lua new file mode 100644 index 0000000..c7a7b9a --- /dev/null +++ b/api/ChangeChatColor.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param messageGroup string +---@param red number +---@param green number +---@param blue number +---Changes the color associated with a chat message type +function ChangeChatColor(messageGroup, red, green, blue) end \ No newline at end of file diff --git a/api/ChannelBan.lua b/api/ChannelBan.lua new file mode 100644 index 0000000..50fbe75 --- /dev/null +++ b/api/ChannelBan.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param channel string +---@param fullname string +---Bans a character from a chat channel. Has no effect unless the player is a moderator of the given channel +function ChannelBan(channel, fullname) end \ No newline at end of file diff --git a/api/ChannelInvite.lua b/api/ChannelInvite.lua new file mode 100644 index 0000000..a637ad6 --- /dev/null +++ b/api/ChannelInvite.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param channel string +---@param name string +---Invites a character to join a chat channel +function ChannelInvite(channel, name) end \ No newline at end of file diff --git a/api/ChannelKick.lua b/api/ChannelKick.lua new file mode 100644 index 0000000..a4b9edb --- /dev/null +++ b/api/ChannelKick.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param channel string +---@param fullname string +---Removes a player from the channel. Has no effect unless the player is a moderator of the given channel +function ChannelKick(channel, fullname) end \ No newline at end of file diff --git a/api/ChannelModerator.lua b/api/ChannelModerator.lua new file mode 100644 index 0000000..714f13f --- /dev/null +++ b/api/ChannelModerator.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param channel string +---@param fullname string +---Grants a character moderator status in a chat channel. Has no effect unless the player is the owner of the given channel +function ChannelModerator(channel, fullname) end \ No newline at end of file diff --git a/api/ChannelMute.lua b/api/ChannelMute.lua new file mode 100644 index 0000000..c1e80eb --- /dev/null +++ b/api/ChannelMute.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param channelName string +---@param channelId number +---@param name string +---Grants a character ability to speak in a moderated chat channel +function ChannelMute(channelName, channelId, name) end \ No newline at end of file diff --git a/api/ChannelSilenceAll.lua b/api/ChannelSilenceAll.lua new file mode 100644 index 0000000..17d27e1 --- /dev/null +++ b/api/ChannelSilenceAll.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param channelName string +---@param channelId number +---@param unit string +---@param name string +---Silences a character for chat and voice on a channel +function ChannelSilenceAll(channelName, channelId, unit, name) end \ No newline at end of file diff --git a/api/ChannelSilenceVoice.lua b/api/ChannelSilenceVoice.lua new file mode 100644 index 0000000..092b4d9 --- /dev/null +++ b/api/ChannelSilenceVoice.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param channelName string +---@param channelId number +---@param unit string +---@param name string +---Silences the given character for voice chat on the channel. Only a raid/party/battleground leader or assistant can silence a player. +function ChannelSilenceVoice(channelName, channelId, unit, name) end \ No newline at end of file diff --git a/api/ChannelToggleAnnouncements.lua b/api/ChannelToggleAnnouncements.lua new file mode 100644 index 0000000..b119732 --- /dev/null +++ b/api/ChannelToggleAnnouncements.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param channel string +---Enables or disables printing of join/leave announcements for a channel +function ChannelToggleAnnouncements(channel) end \ No newline at end of file diff --git a/api/ChannelUnSilenceAll.lua b/api/ChannelUnSilenceAll.lua new file mode 100644 index 0000000..04d9d1f --- /dev/null +++ b/api/ChannelUnSilenceAll.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param channelName string +---@param channelId number +---@param unit string +---@param name string +---Unsilences a character for chat and voice on a channel +function ChannelUnSilenceAll(channelName, channelId, unit, name) end \ No newline at end of file diff --git a/api/ChannelUnSilenceVoice.lua b/api/ChannelUnSilenceVoice.lua new file mode 100644 index 0000000..deb76a7 --- /dev/null +++ b/api/ChannelUnSilenceVoice.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param channelName string +---@param channelId number +---@param unit string +---@param name string +---Unsilences a character on a chat channel +function ChannelUnSilenceVoice(channelName, channelId, unit, name) end \ No newline at end of file diff --git a/api/ChannelUnban.lua b/api/ChannelUnban.lua new file mode 100644 index 0000000..de0181c --- /dev/null +++ b/api/ChannelUnban.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param channel string +---@param fullname string +---Lifts the ban preventing a character from joining a chat channel. Has no effect unless the player is a moderator of the given channel +function ChannelUnban(channel, fullname) end \ No newline at end of file diff --git a/api/ChannelUnmoderator.lua b/api/ChannelUnmoderator.lua new file mode 100644 index 0000000..3a3a9df --- /dev/null +++ b/api/ChannelUnmoderator.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param channel string +---@param fullname string +---Revokes moderator status from a character on a chat channel. Has no effect unless the player is the owner of the given channel +function ChannelUnmoderator(channel, fullname) end \ No newline at end of file diff --git a/api/ChannelUnmute.lua b/api/ChannelUnmute.lua new file mode 100644 index 0000000..ac1da9f --- /dev/null +++ b/api/ChannelUnmute.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param channelName string +---@param channelId number +---@param name string +---Removes a character's ability to speak in a moderated chat channel +function ChannelUnmute(channelName, channelId, name) end \ No newline at end of file diff --git a/api/ChannelVoiceOff.lua b/api/ChannelVoiceOff.lua new file mode 100644 index 0000000..4889ce4 --- /dev/null +++ b/api/ChannelVoiceOff.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param channel string +---@param channelIndex number +---Disables voice chat in a channel +function ChannelVoiceOff(channel, channelIndex) end \ No newline at end of file diff --git a/api/ChannelVoiceOn.lua b/api/ChannelVoiceOn.lua new file mode 100644 index 0000000..dc108de --- /dev/null +++ b/api/ChannelVoiceOn.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param channel string +---@param channelIndex number +---Enables voice chat in a channel +function ChannelVoiceOn(channel, channelIndex) end \ No newline at end of file diff --git a/api/ChatFrame_AddMessageEventFilter.lua b/api/ChatFrame_AddMessageEventFilter.lua new file mode 100644 index 0000000..bf169cc --- /dev/null +++ b/api/ChatFrame_AddMessageEventFilter.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param event string +---@param filter function +---Adds a function to filter or alter messages to the chat display system. The filter function will be called each time a message is sent to one of the default chat frames (ChatFrame1, ChatFrame2, ..., ChatFrame7). The function will be passed the chat frame object that the message is being added to, along with the event that caused the messages to be added, and the arguments to that event. A filter function may return true if the message should be filtered , or false if the message should be displayed. Following this boolean flag, the message can return a list of (possibly) altered arguments to be passed to the next filter function. Note that your function will be called at least once for every ChatFrame the message-event is registered for. Currently (due to what appears to be a bug) the filter is actually called twice for each frame. Due to this non-deterministic calling, your filter function should not have side-effects. See examples for details. +function ChatFrame_AddMessageEventFilter(event, filter) end \ No newline at end of file diff --git a/api/ChatFrame_GetMessageEventFilters.lua b/api/ChatFrame_GetMessageEventFilters.lua new file mode 100644 index 0000000..f528b68 --- /dev/null +++ b/api/ChatFrame_GetMessageEventFilters.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param event string +---@return table filterTable +---Returns the list of filters registered for a chat event. See ChatFrame_AddMessageEventFilter() for details about chat message filters. +function ChatFrame_GetMessageEventFilters(event) end \ No newline at end of file diff --git a/api/ChatFrame_RemoveMessageEventFilter.lua b/api/ChatFrame_RemoveMessageEventFilter.lua new file mode 100644 index 0000000..6d83651 --- /dev/null +++ b/api/ChatFrame_RemoveMessageEventFilter.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param event string +---@param filter function +---Removes a previously set chat message filter. See ChatFrame_AddMessageEventFilter() for details about chat message filters. +function ChatFrame_RemoveMessageEventFilter(event, filter) end \ No newline at end of file diff --git a/api/ChatHistory_GetAccessID.lua b/api/ChatHistory_GetAccessID.lua new file mode 100644 index 0000000..ba041f9 --- /dev/null +++ b/api/ChatHistory_GetAccessID.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param chatType string +---@param chatTarget string +---@return number accessID +---Retrieve an accessID for a combination of chatType and chatTarget. This accessID can be used to filter chat frame messages. +function ChatHistory_GetAccessID(chatType, chatTarget) end \ No newline at end of file diff --git a/api/ChatHistory_GetChatType.lua b/api/ChatHistory_GetChatType.lua new file mode 100644 index 0000000..c39dcf7 --- /dev/null +++ b/api/ChatHistory_GetChatType.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param accessID number +---@return string chatType +---@return string chatTarget +---Retrieve information about an accessID +function ChatHistory_GetChatType(accessID) end \ No newline at end of file diff --git a/api/CheckBinderDist.lua b/api/CheckBinderDist.lua new file mode 100644 index 0000000..9251e82 --- /dev/null +++ b/api/CheckBinderDist.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil inRange +---Returns whether the player is in range of an NPC that can set the Hearthstone location. Usable following the CONFIRM_BINDER event which fires when the player speaks to an Innkeeper (or similar) NPC and chooses to set his or her Hearthstone location. Used in the default UI to hide the confirmation window for such if the player moves too far away from the NPC. +function CheckBinderDist() end \ No newline at end of file diff --git a/api/CheckInbox.lua b/api/CheckInbox.lua new file mode 100644 index 0000000..0c146c5 --- /dev/null +++ b/api/CheckInbox.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Requests information on the player's mailbox contents from the server. Information is not returned immediately; the MAIL_INBOX_UPDATE event fires when data becomes available for use by other Mail/Inbox API functions. +function CheckInbox() end \ No newline at end of file diff --git a/api/CheckInteractDistance.lua b/api/CheckInteractDistance.lua new file mode 100644 index 0000000..0dcad90 --- /dev/null +++ b/api/CheckInteractDistance.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param distIndex 4 +---@param 1 +---@param 2 +---@param 3 +---@param 4 +---@return 1nil canInteract +---Returns whether the player is close enough to a unit for certain types of interaction +function CheckInteractDistance(unit, distIndex, 1, 2, 3, 4) end \ No newline at end of file diff --git a/api/CheckSpiritHealerDist.lua b/api/CheckSpiritHealerDist.lua new file mode 100644 index 0000000..fa30ca7 --- /dev/null +++ b/api/CheckSpiritHealerDist.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil inRange +---Returns whether the player is in range of a spirit healer. Usable following the CONFIRM_XP_LOSS event which fires upon speaking to a spirit healer while dead and choosing the option to immediately resurrect. Used in the default UI to hide the confirmation window for such if the player moves too far away from the spirit healer. +function CheckSpiritHealerDist() end \ No newline at end of file diff --git a/api/CheckTalentMasterDist.lua b/api/CheckTalentMasterDist.lua new file mode 100644 index 0000000..9ece663 --- /dev/null +++ b/api/CheckTalentMasterDist.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil inRange +---Returns whether the player is in range of an NPC that can reset talents. Usable following the CONFIRM_TALENT_WIPE event which fires when the player speaks to an trainer NPC and chooses to reset his or her talents. Used in the default UI to hide the confirmation window for such if the player moves too far away from the NPC. +function CheckTalentMasterDist() end \ No newline at end of file diff --git a/api/ClearAchievementComparisonUnit.lua b/api/ClearAchievementComparisonUnit.lua new file mode 100644 index 0000000..0279fc7 --- /dev/null +++ b/api/ClearAchievementComparisonUnit.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Disables comparing achievements/statistics with another player +function ClearAchievementComparisonUnit() end \ No newline at end of file diff --git a/api/ClearAllLFGDungeons.lua b/api/ClearAllLFGDungeons.lua new file mode 100644 index 0000000..d1816fe --- /dev/null +++ b/api/ClearAllLFGDungeons.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Removes the player from all LFD queues. +function ClearAllLFGDungeons() end \ No newline at end of file diff --git a/api/ClearAllTracking.lua b/api/ClearAllTracking.lua new file mode 100644 index 0000000..1f66594 --- /dev/null +++ b/api/ClearAllTracking.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ClearAllTracking() end \ No newline at end of file diff --git a/api/ClearAutoAcceptQuestSound.lua b/api/ClearAutoAcceptQuestSound.lua new file mode 100644 index 0000000..633b7c8 --- /dev/null +++ b/api/ClearAutoAcceptQuestSound.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ClearAutoAcceptQuestSound() end \ No newline at end of file diff --git a/api/ClearBlacklistMap.lua b/api/ClearBlacklistMap.lua new file mode 100644 index 0000000..982887a --- /dev/null +++ b/api/ClearBlacklistMap.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param BGMapID number +---Remove battleground from blacklist. +function ClearBlacklistMap(BGMapID) end \ No newline at end of file diff --git a/api/ClearCursor.lua b/api/ClearCursor.lua new file mode 100644 index 0000000..b3e161a --- /dev/null +++ b/api/ClearCursor.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Clears any contents attached to the cursor. If the cursor contains an item picked up from inventory (equipment slots) or a container, the item returns to its point of origin and the inventory or container slot is unlocked. (To destroy an item, see DeleteCursorItem()). If the cursor contains an action, that action is deleted (but not the spell, item, macro, etc that it represents). If the cursor contains any other data type, nothing happens other than the cursor being reverted to its default state -- picking up such objects has no effect on their points of origin. +function ClearCursor() end \ No newline at end of file diff --git a/api/ClearFocus.lua b/api/ClearFocus.lua new file mode 100644 index 0000000..624c431 --- /dev/null +++ b/api/ClearFocus.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Clears the player's focus unit +function ClearFocus() end \ No newline at end of file diff --git a/api/ClearInspectPlayer.lua b/api/ClearInspectPlayer.lua new file mode 100644 index 0000000..8ad97c0 --- /dev/null +++ b/api/ClearInspectPlayer.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends inspection of another character. After this function is called, data about the inspected unit may not be available or valid. Used in the default UI when the InspectFrame is hidden. +function ClearInspectPlayer() end \ No newline at end of file diff --git a/api/ClearItemUpgrade.lua b/api/ClearItemUpgrade.lua new file mode 100644 index 0000000..92a11e7 --- /dev/null +++ b/api/ClearItemUpgrade.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Removes the item from the upgrade dialog. This function can currently only be called when at the upgrade merchant +function ClearItemUpgrade() end \ No newline at end of file diff --git a/api/ClearMissingLootDisplay.lua b/api/ClearMissingLootDisplay.lua new file mode 100644 index 0000000..be0d633 --- /dev/null +++ b/api/ClearMissingLootDisplay.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ClearMissingLootDisplay() end \ No newline at end of file diff --git a/api/ClearOverrideBindings.lua b/api/ClearOverrideBindings.lua new file mode 100644 index 0000000..02cd10d --- /dev/null +++ b/api/ClearOverrideBindings.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param owner table +---Clears any registered override bindings for a given owner. An override binding is a temporary key or click binding that can be used to override the default bindings. The bound key will revert to its normal setting once the override has been removed. +function ClearOverrideBindings(owner) end \ No newline at end of file diff --git a/api/ClearPartyAssignment.lua b/api/ClearPartyAssignment.lua new file mode 100644 index 0000000..24eecc1 --- /dev/null +++ b/api/ClearPartyAssignment.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param assignment MAINTANK +---@param MAINASSIST +---@param MAINTANK +---@param unit string +---@param name string +---@param exactMatch boolean +---Removes a group role assignment from a member of the player's party or raid. If no unit (or name) is given, removes the role assignment from all members of the party or raid. +function ClearPartyAssignment(assignment, MAINASSIST, MAINTANK, unit, name, exactMatch) end \ No newline at end of file diff --git a/api/ClearRaidMarker.lua b/api/ClearRaidMarker.lua new file mode 100644 index 0000000..1c9a205 --- /dev/null +++ b/api/ClearRaidMarker.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ClearRaidMarker() end \ No newline at end of file diff --git a/api/ClearSendMail.lua b/api/ClearSendMail.lua new file mode 100644 index 0000000..dd04a7b --- /dev/null +++ b/api/ClearSendMail.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Clears any text, items, or money from the mail to be sent +function ClearSendMail() end \ No newline at end of file diff --git a/api/ClearTarget.lua b/api/ClearTarget.lua new file mode 100644 index 0000000..ba011b4 --- /dev/null +++ b/api/ClearTarget.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Clears the player's current target +function ClearTarget() end \ No newline at end of file diff --git a/api/ClearTransmogrifySlot.lua b/api/ClearTransmogrifySlot.lua new file mode 100644 index 0000000..b40fadf --- /dev/null +++ b/api/ClearTransmogrifySlot.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ClearTransmogrifySlot() end \ No newline at end of file diff --git a/api/ClearTutorials.lua b/api/ClearTutorials.lua new file mode 100644 index 0000000..d314642 --- /dev/null +++ b/api/ClearTutorials.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Disables contextual tutorial display +function ClearTutorials() end \ No newline at end of file diff --git a/api/ClearVoidTransferDepositSlot.lua b/api/ClearVoidTransferDepositSlot.lua new file mode 100644 index 0000000..c2b1c5d --- /dev/null +++ b/api/ClearVoidTransferDepositSlot.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ClearVoidTransferDepositSlot() end \ No newline at end of file diff --git a/api/ClickAuctionSellItemButton.lua b/api/ClickAuctionSellItemButton.lua new file mode 100644 index 0000000..93c50df --- /dev/null +++ b/api/ClickAuctionSellItemButton.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Picks up an item from or puts an item into the "Create Auction" slot. If the cursor is empty and the slot contains an item, that item is put onto the cursor. If the cursor contains an item and the slot is empty, the item is placed into the slot. If both the cursor and the slot contain items, the contents of the cursor and the slot are exchanged. Only has effect if the player is interacting with an auctioneer (i.e. between the AUCTION_HOUSE_SHOW and AUCTION_HOUSE_CLOSED events). Causes an error message (UI_ERROR_MESSAGE) if the item on the cursor cannot be put up for auction (e.g. if the item is soulbound). +function ClickAuctionSellItemButton() end \ No newline at end of file diff --git a/api/ClickLandmark.lua b/api/ClickLandmark.lua new file mode 100644 index 0000000..74e6abd --- /dev/null +++ b/api/ClickLandmark.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param mapLinkID number +---Processes a hyperlink associated with a map landmark. Possible landmarks include PvP objectives (both in battlegrounds and in world PvP areas), town and city markers on continent maps, and special markers such as those used during the Scourge Invasion world event. Some landmarks (such as those for towns on a zone map) exist but are not visible in the default UI. Hyperlinks are not used for any of the landmarks currently in the game; this function does nothing when called with a landmark which does not have a hyperlink. +function ClickLandmark(mapLinkID) end \ No newline at end of file diff --git a/api/ClickSendMailItemButton.lua b/api/ClickSendMailItemButton.lua new file mode 100644 index 0000000..894682d --- /dev/null +++ b/api/ClickSendMailItemButton.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param autoReturn boolean +---Picks up an item from or puts an item into an attachment slot for sending mail. If the cursor is empty and the mail attachment slot contains an item, that item is put onto the cursor. If the cursor contains an item and the slot is empty, the item is placed into the slot. If both the cursor and the slot contain items, the contents of the cursor and the mail attachment slot are exchanged. Only has effect if the player is interacting with a mailbox (i.e. between the MAIL_SHOW and MAIL_CLOSED events). Causes an error message (UI_ERROR_MESSAGE) if an invalid mail attachment slot is specified or if the item on the cursor cannot be mailed (e.g. if the item is soulbound). +function ClickSendMailItemButton(index, autoReturn) end \ No newline at end of file diff --git a/api/ClickSocketButton.lua b/api/ClickSocketButton.lua new file mode 100644 index 0000000..1b33b29 --- /dev/null +++ b/api/ClickSocketButton.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Picks up or places a gem in the Item Socketing UI. If the Item Socketing UI is open and the cursor contains a socketable gem, places the gem into socket index. If the cursor does not hold an item and socket index is not locked, picks up the gem in that socket. Only has an effect while the Item Socketing UI is open (i.e. between the SOCKET_INFO_UPDATE and SOCKET_INFO_CLOSE events). +function ClickSocketButton(index) end \ No newline at end of file diff --git a/api/ClickTargetTradeButton.lua b/api/ClickTargetTradeButton.lua new file mode 100644 index 0000000..12e87c6 --- /dev/null +++ b/api/ClickTargetTradeButton.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Interacts with an item in a slot offered for trade by the target. Only meaningful when used with the last (7th) trade slot: if an enchantment-type spell is currently awaiting a target (i.e. the glowing hand cursor is showing), targets the item in the given trade slot for the enchantment. (The enchantment to be applied then shows for both parties in the trade, but is not actually performed until both parties accept the trade.) +function ClickTargetTradeButton(index) end \ No newline at end of file diff --git a/api/ClickTradeButton.lua b/api/ClickTradeButton.lua new file mode 100644 index 0000000..c6a0150 --- /dev/null +++ b/api/ClickTradeButton.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Picks up an item from or puts an item in a slot offered for trade by the player. Results vary by context: If an item is on the cursor and no item is in the trade slot, the item is put into the trade slot and the cursor becomes empty If no item is on the cursor and an item is in the trade slot, the item is put on the cursor and removed from the trade slot If an item is on the cursor and an item is in the trade slot, the item from the cursor is put into the trade slot and the item from the trade slot is put on the cursor If both cursor and trade slot are empty, nothing happens +function ClickTradeButton(index) end \ No newline at end of file diff --git a/api/ClickTransmogrifySlot.lua b/api/ClickTransmogrifySlot.lua new file mode 100644 index 0000000..a647fb5 --- /dev/null +++ b/api/ClickTransmogrifySlot.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ClickTransmogrifySlot() end \ No newline at end of file diff --git a/api/ClickVoidStorageSlot.lua b/api/ClickVoidStorageSlot.lua new file mode 100644 index 0000000..ac2723b --- /dev/null +++ b/api/ClickVoidStorageSlot.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param isRightClick 1nil +---Allows to 'move' an item from the void storages content to the withdrawal box. Such a 'moved' item will be locked in the content until the transfer happens or the item is removed from the withdrawal box. Locking happens as soon as a click happened. If isRightClick is set the item is put in the first empty withdrawal slot. If isRichtClick is not set the item is attached to the mouse until it is either released to the content (by right clicking) or manually placed either in the content or any withdrawal box slot. +function ClickVoidStorageSlot(index, isRightClick) end \ No newline at end of file diff --git a/api/ClickVoidTransferDepositSlot.lua b/api/ClickVoidTransferDepositSlot.lua new file mode 100644 index 0000000..8535174 --- /dev/null +++ b/api/ClickVoidTransferDepositSlot.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param isRightClick 1nil +---Allows to 'move' an item from the void storages deposit box back to inventory. The 'moved' item will subsequently be unlocked in the inventory. If isRightClick is set the item is returned and unlocked immediately. If isRightClick is not set the item is attached to the mouse until it is either released to the inventory (by right clicking) or manually placed either in the inventory or any deposit slot. +function ClickVoidTransferDepositSlot(index, isRightClick) end \ No newline at end of file diff --git a/api/ClickVoidTransferWithdrawalSlot.lua b/api/ClickVoidTransferWithdrawalSlot.lua new file mode 100644 index 0000000..38db64c --- /dev/null +++ b/api/ClickVoidTransferWithdrawalSlot.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param isRightClick 1nil +---Allows to 'move' an item from the void storages withdrawal box to content. If isRightClick is set the item is immediately removed from the withdrawal box and unlocked in content. If isRichtClick is not set the item is attached to the mouse until it is either released to the content (by right clicking) or manually placed either in the content or any withdrawal box slot. +function ClickVoidTransferWithdrawalSlot(index, isRightClick) end \ No newline at end of file diff --git a/api/CloseAuctionHouse.lua b/api/CloseAuctionHouse.lua new file mode 100644 index 0000000..f194099 --- /dev/null +++ b/api/CloseAuctionHouse.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends interaction with the Auction House UI. Causes the AUCTION_HOUSE_CLOSED event to fire, indicating that Auction-related APIs may be unavailable or no longer return valid data. +function CloseAuctionHouse() end \ No newline at end of file diff --git a/api/CloseBankFrame.lua b/api/CloseBankFrame.lua new file mode 100644 index 0000000..8b93911 --- /dev/null +++ b/api/CloseBankFrame.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends interaction with the bank. Causes the BANKFRAME_CLOSED event to fire, indicating that APIs querying bank contents may no longer return valid results. +function CloseBankFrame() end \ No newline at end of file diff --git a/api/CloseGossip.lua b/api/CloseGossip.lua new file mode 100644 index 0000000..a22f2b8 --- /dev/null +++ b/api/CloseGossip.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends an NPC "gossip" interaction. Causes the GOSSIP_CLOSED event to fire, indicating that Gossip APIs may no longer have effects or return valid data. +function CloseGossip() end \ No newline at end of file diff --git a/api/CloseGuildBankFrame.lua b/api/CloseGuildBankFrame.lua new file mode 100644 index 0000000..dc9a250 --- /dev/null +++ b/api/CloseGuildBankFrame.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends interaction with the guild bank vault. Fires the GUILDBANKFRAME_CLOSED event, indicating that APIs related to the Guild Bank vault may no longer have effects or return valid data. (APIs related to guild bank permissions are still usable.) +function CloseGuildBankFrame() end \ No newline at end of file diff --git a/api/CloseGuildRegistrar.lua b/api/CloseGuildRegistrar.lua new file mode 100644 index 0000000..ad6140f --- /dev/null +++ b/api/CloseGuildRegistrar.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends interaction with a guild registrar. Fires the GUILD_REGISTRAR_CLOSED event, indicating that guild registrar APIs may no longer have effects or return valid data. +function CloseGuildRegistrar() end \ No newline at end of file diff --git a/api/CloseGuildRoster.lua b/api/CloseGuildRoster.lua new file mode 100644 index 0000000..73f6c45 --- /dev/null +++ b/api/CloseGuildRoster.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CloseGuildRoster() end \ No newline at end of file diff --git a/api/CloseItemText.lua b/api/CloseItemText.lua new file mode 100644 index 0000000..1f70401 --- /dev/null +++ b/api/CloseItemText.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends interaction with a text object or item. Causes the ITEM_TEXT_CLOSED event to fire, indicating that ItemText APIs are no longer valid. Called by the default UI when closing the ItemTextFrame, which is used for both readable world objects (books, plaques, gravestones, etc) and readable items (looted books, various quest-related scrolls and parchments, saved mail messages, etc). +function CloseItemText() end \ No newline at end of file diff --git a/api/CloseItemUpgrade.lua b/api/CloseItemUpgrade.lua new file mode 100644 index 0000000..14d4d26 --- /dev/null +++ b/api/CloseItemUpgrade.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CloseItemUpgrade() end \ No newline at end of file diff --git a/api/CloseLoot.lua b/api/CloseLoot.lua new file mode 100644 index 0000000..adbcbc0 --- /dev/null +++ b/api/CloseLoot.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends interaction with a lootable corpse or object. Causes the LOOT_CLOSED event to fire, indicating that Loot APIs may no longer have effects or return valid data. If the corpse was designated as the player's loot (via the Round Robin, Group Loot, or Need Before Greed loot methods), the corpse's loot becomes available to the rest of the group. If (and only if) the loot was generated from Disenchanting, Prospecting, Milling or similar, all loot items are automatically picked up. +function CloseLoot() end \ No newline at end of file diff --git a/api/CloseMail.lua b/api/CloseMail.lua new file mode 100644 index 0000000..195b146 --- /dev/null +++ b/api/CloseMail.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends interaction with a mailbox. Fires the MAIL_CLOSED event, indicating that Mail/Inbox APIs may no longer have effects or return valid data. +function CloseMail() end \ No newline at end of file diff --git a/api/CloseMerchant.lua b/api/CloseMerchant.lua new file mode 100644 index 0000000..ad066a1 --- /dev/null +++ b/api/CloseMerchant.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends interaction with a vendor. Causes the MERCHANT_CLOSED event to fire, indicating that Merchant APIs may no longer have effects or return valid data. +function CloseMerchant() end \ No newline at end of file diff --git a/api/ClosePetStables.lua b/api/ClosePetStables.lua new file mode 100644 index 0000000..6533654 --- /dev/null +++ b/api/ClosePetStables.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends use of the Pet Stables UI/API. Causes the PET_STABLE_CLOSED event to fire, indicating that stables-related APIs are no longer valid. +function ClosePetStables() end \ No newline at end of file diff --git a/api/ClosePetition.lua b/api/ClosePetition.lua new file mode 100644 index 0000000..be52486 --- /dev/null +++ b/api/ClosePetition.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends interaction with a petition. Fires the PETITION_CLOSED event, indicating that Petition APIs may no longer have effects or return valid data. +function ClosePetition() end \ No newline at end of file diff --git a/api/CloseQuest.lua b/api/CloseQuest.lua new file mode 100644 index 0000000..40ddcd1 --- /dev/null +++ b/api/CloseQuest.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends interaction with a questgiver. Fires the QUEST_FINISHED event, indicating that questgiver-related APIs may no longer have effects or return valid data. +function CloseQuest() end \ No newline at end of file diff --git a/api/CloseQuestChoice.lua b/api/CloseQuestChoice.lua new file mode 100644 index 0000000..a7caea3 --- /dev/null +++ b/api/CloseQuestChoice.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CloseQuestChoice() end \ No newline at end of file diff --git a/api/CloseSocketInfo.lua b/api/CloseSocketInfo.lua new file mode 100644 index 0000000..f8c7897 --- /dev/null +++ b/api/CloseSocketInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends interaction with the Item Socketing UI, discarding any changes made. Causes the SOCKET_INFO_CLOSE event to fire, indicating that Socket API functions may no longer have effects or return valid data. +function CloseSocketInfo() end \ No newline at end of file diff --git a/api/CloseTabardCreation.lua b/api/CloseTabardCreation.lua new file mode 100644 index 0000000..557dc6a --- /dev/null +++ b/api/CloseTabardCreation.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends interaction with the guild tabard creator. Fires the CLOSE_TABARD_FRAME event, indicating that tabard creation APIs may no longer have effects or return valid data. +function CloseTabardCreation() end \ No newline at end of file diff --git a/api/CloseTaxiMap.lua b/api/CloseTaxiMap.lua new file mode 100644 index 0000000..f21d95c --- /dev/null +++ b/api/CloseTaxiMap.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends interaction with the Taxi (flight master) UI. Causes the TAXIMAP_CLOSED event to fire, indicating that Taxi APIs may no longer have effects or return valid data. +function CloseTaxiMap() end \ No newline at end of file diff --git a/api/CloseTrade.lua b/api/CloseTrade.lua new file mode 100644 index 0000000..049b6d0 --- /dev/null +++ b/api/CloseTrade.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends interaction with the Trade UI, canceling any trade in progress. Causes the TRADE_CLOSED event to fire, indicating that Trade APIs may no longer have effects or return valid data. +function CloseTrade() end \ No newline at end of file diff --git a/api/CloseTradeSkill.lua b/api/CloseTradeSkill.lua new file mode 100644 index 0000000..c6fcea9 --- /dev/null +++ b/api/CloseTradeSkill.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends interaction with the Trade Skill UI. Fires the TRADE_SKILL_CLOSE event, indicating that TradeSkill APIs may no longer have effects or return valid data. +function CloseTradeSkill() end \ No newline at end of file diff --git a/api/CloseTrainer.lua b/api/CloseTrainer.lua new file mode 100644 index 0000000..2b52dde --- /dev/null +++ b/api/CloseTrainer.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends interaction with a trainer. Fires the TRAINER_CLOSED event, indicating that Trainer APIs may no longer have effects or return valid data. +function CloseTrainer() end \ No newline at end of file diff --git a/api/CloseTransmogrifyFrame.lua b/api/CloseTransmogrifyFrame.lua new file mode 100644 index 0000000..d753464 --- /dev/null +++ b/api/CloseTransmogrifyFrame.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CloseTransmogrifyFrame() end \ No newline at end of file diff --git a/api/CloseVoidStorageFrame.lua b/api/CloseVoidStorageFrame.lua new file mode 100644 index 0000000..91a2858 --- /dev/null +++ b/api/CloseVoidStorageFrame.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CloseVoidStorageFrame() end \ No newline at end of file diff --git a/api/ClosestUnitPosition.lua b/api/ClosestUnitPosition.lua new file mode 100644 index 0000000..62d77a6 --- /dev/null +++ b/api/ClosestUnitPosition.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ClosestUnitPosition() end \ No newline at end of file diff --git a/api/CollapseAllFactionHeaders.lua b/api/CollapseAllFactionHeaders.lua new file mode 100644 index 0000000..9a7a8ea --- /dev/null +++ b/api/CollapseAllFactionHeaders.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Collapses all headers and sub-headers in the Reputation UI. This function works for both major groups (Classic, Burning Crusade, Wrath of the Lich King, Inactive, etc.) and the sub-groups within them (Alliance Forces, Steamwheedle Cartel, Horde Expedition, Shattrath City, etc.). +function CollapseAllFactionHeaders() end \ No newline at end of file diff --git a/api/CollapseChannelHeader.lua b/api/CollapseChannelHeader.lua new file mode 100644 index 0000000..a958ee7 --- /dev/null +++ b/api/CollapseChannelHeader.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Collapses a group header in the chat channel listing +function CollapseChannelHeader(index) end \ No newline at end of file diff --git a/api/CollapseFactionHeader.lua b/api/CollapseFactionHeader.lua new file mode 100644 index 0000000..b3428ae --- /dev/null +++ b/api/CollapseFactionHeader.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Collapses a given faction header or sub-header in the Reputation UI. Faction headers include both major groups (Classic, Burning Crusade, Wrath of the Lich King, Inactive, etc.) and the sub-groups within them (Alliance Forces, Steamwheedle Cartel, Horde Expedition, Shattrath City, etc.). +function CollapseFactionHeader(index) end \ No newline at end of file diff --git a/api/CollapseGuildTradeSkillHeader.lua b/api/CollapseGuildTradeSkillHeader.lua new file mode 100644 index 0000000..501f911 --- /dev/null +++ b/api/CollapseGuildTradeSkillHeader.lua @@ -0,0 +1,16 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param professionID 773 +---@param 164 +---@param 165 +---@param 171 +---@param 182 +---@param 186 +---@param 197 +---@param 202 +---@param 333 +---@param 393 +---@param 755 +---@param 773 +---Collapses the corresponding profession in the guild window. This function is used to collapse a single profession in the guild window (professions view) based on its ID. Can also be done while window is not visible. See ExpandGuildTradeSkillHeader() for opening the view. +function CollapseGuildTradeSkillHeader(professionID, 164, 165, 171, 182, 186, 197, 202, 333, 393, 755, 773) end \ No newline at end of file diff --git a/api/CollapseQuestHeader.lua b/api/CollapseQuestHeader.lua new file mode 100644 index 0000000..feb72d1 --- /dev/null +++ b/api/CollapseQuestHeader.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param questIndex number +---Collapses a header in the quest log +function CollapseQuestHeader(questIndex) end \ No newline at end of file diff --git a/api/CollapseTradeSkillSubClass.lua b/api/CollapseTradeSkillSubClass.lua new file mode 100644 index 0000000..015b678 --- /dev/null +++ b/api/CollapseTradeSkillSubClass.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Collapses a group header in the trade skill listing. Causes an error if index does not refer to a header. +function CollapseTradeSkillSubClass(index) end \ No newline at end of file diff --git a/api/CollapseWarGameHeader.lua b/api/CollapseWarGameHeader.lua new file mode 100644 index 0000000..0d55f0d --- /dev/null +++ b/api/CollapseWarGameHeader.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CollapseWarGameHeader() end \ No newline at end of file diff --git a/api/CombatLogAddFilter.lua b/api/CombatLogAddFilter.lua new file mode 100644 index 0000000..bec742f --- /dev/null +++ b/api/CombatLogAddFilter.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param events string +---@param srcGUID string +---@param srcMask number +---@param destGUID string +---@param destMask number +---Adds a filter to the combat log system. Each time this function is called a new filter is added to the combat log system. Any combat log entry that passes the filter will be fired as a COMBAT_LOG_EVENT event in order from oldest to newest. +function CombatLogAddFilter(events, srcGUID, srcMask, destGUID, destMask) end \ No newline at end of file diff --git a/api/CombatLogAdvanceEntry.lua b/api/CombatLogAdvanceEntry.lua new file mode 100644 index 0000000..dd1fa79 --- /dev/null +++ b/api/CombatLogAdvanceEntry.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param count number +---@param ignoreFilter boolean +---@return 1nil hasEntry +---Advances the "cursor" position used by other CombatLog functions. Information about the entry at the "cursor" position can be retrieved with CombatLogGetCurrentEntry(). That function then advances the cursor to the next entry, so calling it repeatedly returns all information in the combat log -- this function can be used to "rewind" the combat log to retrieve information about earlier events or skip entries without retrieving their information. +function CombatLogAdvanceEntry(count, ignoreFilter) end \ No newline at end of file diff --git a/api/CombatLogClearEntries.lua b/api/CombatLogClearEntries.lua new file mode 100644 index 0000000..f8990b4 --- /dev/null +++ b/api/CombatLogClearEntries.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Removes all entries from the combat log +function CombatLogClearEntries() end \ No newline at end of file diff --git a/api/CombatLogGetCurrentEntry.lua b/api/CombatLogGetCurrentEntry.lua new file mode 100644 index 0000000..b441451 --- /dev/null +++ b/api/CombatLogGetCurrentEntry.lua @@ -0,0 +1,14 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param ignoreFilter boolean +---@return number timestamp +---@return string event +---@return string srcGUID +---@return string srcName +---@return number srcFlags +---@return string destGUID +---@return string destName +---@return number destFlags +---@return list ... +---Returns the combat log event information for the current entry and advances to the next entry. See COMBAT_LOG_EVENT for details of the event information. The combat log maintains a "cursor" in the list of entries; this function returns information about the event at the cursor position and advances the cursor to the next entry. Since this function is used by the default UI's combat log display, the cursor position is usually at the end of the log -- calling it thus returns nothing. The function CombatLogSetCurrentEntry() can be used to "rewind" the combat log cursor, enabling retrieval of information about earlier events. +function CombatLogGetCurrentEntry(ignoreFilter) end \ No newline at end of file diff --git a/api/CombatLogGetNumEntries.lua b/api/CombatLogGetNumEntries.lua new file mode 100644 index 0000000..2c3b57a --- /dev/null +++ b/api/CombatLogGetNumEntries.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param ignoreFilter boolean +---Returns the number of available combat log events +function CombatLogGetNumEntries(ignoreFilter) end \ No newline at end of file diff --git a/api/CombatLogGetRetentionTime.lua b/api/CombatLogGetRetentionTime.lua new file mode 100644 index 0000000..80451f5 --- /dev/null +++ b/api/CombatLogGetRetentionTime.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number seconds +---Returns the amount of time combat log entries are stored +function CombatLogGetRetentionTime() end \ No newline at end of file diff --git a/api/CombatLogResetFilter.lua b/api/CombatLogResetFilter.lua new file mode 100644 index 0000000..d44b052 --- /dev/null +++ b/api/CombatLogResetFilter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Removes any filters applied to the combat log +function CombatLogResetFilter() end \ No newline at end of file diff --git a/api/CombatLogSetCurrentEntry.lua b/api/CombatLogSetCurrentEntry.lua new file mode 100644 index 0000000..699be53 --- /dev/null +++ b/api/CombatLogSetCurrentEntry.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param ignoreFilter boolean +---Sets the "cursor" position used by other CombatLog functions. Information about the entry at the "cursor" position can be retrieved with CombatLogGetCurrentEntry(). That function then advances the cursor to the next entry, so calling it repeatedly returns all information in the combat log -- this function can be used to "rewind" the combat log to retrieve information about earlier events. The argument index can be positive or negative: positive indices start at the beginning of the combat log (oldest events) and count up to the end (newest events); negative indices start at -1 for the newest event and count backwards to to -CombatLogGetNumEntries(ignoreFilter) for the oldest. +function CombatLogSetCurrentEntry(index, ignoreFilter) end \ No newline at end of file diff --git a/api/CombatLogSetRetentionTime.lua b/api/CombatLogSetRetentionTime.lua new file mode 100644 index 0000000..9efc02f --- /dev/null +++ b/api/CombatLogSetRetentionTime.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param seconds number +---Sets the amount of time combat log entries will be stored +function CombatLogSetRetentionTime(seconds) end \ No newline at end of file diff --git a/api/CombatLog_Object_IsA.lua b/api/CombatLog_Object_IsA.lua new file mode 100644 index 0000000..181e8cb --- /dev/null +++ b/api/CombatLog_Object_IsA.lua @@ -0,0 +1,16 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unitFlags number +---@param mask COMBATLOG_FILTER_UNKNOWN_UNITS +---@param COMBATLOG_FILTER_EVERYTHING +---@param COMBATLOG_FILTER_FRIENDLY_UNITS +---@param COMBATLOG_FILTER_HOSTILE_PLAYERS +---@param COMBATLOG_FILTER_HOSTILE_UNITS +---@param COMBATLOG_FILTER_ME +---@param COMBATLOG_FILTER_MINE +---@param COMBATLOG_FILTER_MY_PET +---@param COMBATLOG_FILTER_NEUTRAL_UNITS +---@param COMBATLOG_FILTER_UNKNOWN_UNITS +---@return 1nil isMatch +---Returns whether an entity from the combat log matches a given filter +function CombatLog_Object_IsA(unitFlags, mask, COMBATLOG_FILTER_EVERYTHING, COMBATLOG_FILTER_FRIENDLY_UNITS, COMBATLOG_FILTER_HOSTILE_PLAYERS, COMBATLOG_FILTER_HOSTILE_UNITS, COMBATLOG_FILTER_ME, COMBATLOG_FILTER_MINE, COMBATLOG_FILTER_MY_PET, COMBATLOG_FILTER_NEUTRAL_UNITS, COMBATLOG_FILTER_UNKNOWN_UNITS) end \ No newline at end of file diff --git a/api/CombatTextSetActiveUnit.lua b/api/CombatTextSetActiveUnit.lua new file mode 100644 index 0000000..77782ca --- /dev/null +++ b/api/CombatTextSetActiveUnit.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit unitid +---Sets the main unit for display of floating combat text. Certain types of floating combat text are only displayed for the "active" unit (normally the player): incoming damage, incoming heals, mana/energy/power gains, low health/mana warnings, etc. This function is used by the default UI to allow the player's vehicle to "stand in" for the player for purposes of combat text; using this function with units other than "player" or "vehicle" has no effect. +function CombatTextSetActiveUnit(unit) end \ No newline at end of file diff --git a/api/CommentatorEnterInstance.lua b/api/CommentatorEnterInstance.lua new file mode 100644 index 0000000..2e4ec28 --- /dev/null +++ b/api/CommentatorEnterInstance.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CommentatorEnterInstance() end \ No newline at end of file diff --git a/api/CommentatorExitInstance.lua b/api/CommentatorExitInstance.lua new file mode 100644 index 0000000..8249336 --- /dev/null +++ b/api/CommentatorExitInstance.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CommentatorExitInstance() end \ No newline at end of file diff --git a/api/CommentatorFollowPlayer.lua b/api/CommentatorFollowPlayer.lua new file mode 100644 index 0000000..1e9957e --- /dev/null +++ b/api/CommentatorFollowPlayer.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CommentatorFollowPlayer() end \ No newline at end of file diff --git a/api/CommentatorFollowUnit.lua b/api/CommentatorFollowUnit.lua new file mode 100644 index 0000000..2b2221c --- /dev/null +++ b/api/CommentatorFollowUnit.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CommentatorFollowUnit() end \ No newline at end of file diff --git a/api/CommentatorGetCamera.lua b/api/CommentatorGetCamera.lua new file mode 100644 index 0000000..28bd4d1 --- /dev/null +++ b/api/CommentatorGetCamera.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CommentatorGetCamera() end \ No newline at end of file diff --git a/api/CommentatorGetCurrentMapID.lua b/api/CommentatorGetCurrentMapID.lua new file mode 100644 index 0000000..99b88df --- /dev/null +++ b/api/CommentatorGetCurrentMapID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CommentatorGetCurrentMapID() end \ No newline at end of file diff --git a/api/CommentatorGetInstanceInfo.lua b/api/CommentatorGetInstanceInfo.lua new file mode 100644 index 0000000..0e9d78e --- /dev/null +++ b/api/CommentatorGetInstanceInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CommentatorGetInstanceInfo() end \ No newline at end of file diff --git a/api/CommentatorGetMapInfo.lua b/api/CommentatorGetMapInfo.lua new file mode 100644 index 0000000..9dfb0f4 --- /dev/null +++ b/api/CommentatorGetMapInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CommentatorGetMapInfo() end \ No newline at end of file diff --git a/api/CommentatorGetMode.lua b/api/CommentatorGetMode.lua new file mode 100644 index 0000000..e948709 --- /dev/null +++ b/api/CommentatorGetMode.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CommentatorGetMode() end \ No newline at end of file diff --git a/api/CommentatorGetNumMaps.lua b/api/CommentatorGetNumMaps.lua new file mode 100644 index 0000000..3d11b46 --- /dev/null +++ b/api/CommentatorGetNumMaps.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CommentatorGetNumMaps() end \ No newline at end of file diff --git a/api/CommentatorGetNumPlayers.lua b/api/CommentatorGetNumPlayers.lua new file mode 100644 index 0000000..53e5e36 --- /dev/null +++ b/api/CommentatorGetNumPlayers.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CommentatorGetNumPlayers() end \ No newline at end of file diff --git a/api/CommentatorGetPlayerInfo.lua b/api/CommentatorGetPlayerInfo.lua new file mode 100644 index 0000000..62f2cac --- /dev/null +++ b/api/CommentatorGetPlayerInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CommentatorGetPlayerInfo() end \ No newline at end of file diff --git a/api/CommentatorLookatPlayer.lua b/api/CommentatorLookatPlayer.lua new file mode 100644 index 0000000..7dcc1b4 --- /dev/null +++ b/api/CommentatorLookatPlayer.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CommentatorLookatPlayer() end \ No newline at end of file diff --git a/api/CommentatorSetCamera.lua b/api/CommentatorSetCamera.lua new file mode 100644 index 0000000..22e6f29 --- /dev/null +++ b/api/CommentatorSetCamera.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CommentatorSetCamera() end \ No newline at end of file diff --git a/api/CommentatorSetCameraCollision.lua b/api/CommentatorSetCameraCollision.lua new file mode 100644 index 0000000..9375220 --- /dev/null +++ b/api/CommentatorSetCameraCollision.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CommentatorSetCameraCollision() end \ No newline at end of file diff --git a/api/CommentatorSetMapAndInstanceIndex.lua b/api/CommentatorSetMapAndInstanceIndex.lua new file mode 100644 index 0000000..083a3c5 --- /dev/null +++ b/api/CommentatorSetMapAndInstanceIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CommentatorSetMapAndInstanceIndex() end \ No newline at end of file diff --git a/api/CommentatorSetMode.lua b/api/CommentatorSetMode.lua new file mode 100644 index 0000000..f310fbf --- /dev/null +++ b/api/CommentatorSetMode.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CommentatorSetMode() end \ No newline at end of file diff --git a/api/CommentatorSetMoveSpeed.lua b/api/CommentatorSetMoveSpeed.lua new file mode 100644 index 0000000..4314c64 --- /dev/null +++ b/api/CommentatorSetMoveSpeed.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CommentatorSetMoveSpeed() end \ No newline at end of file diff --git a/api/CommentatorSetTargetHeightOffset.lua b/api/CommentatorSetTargetHeightOffset.lua new file mode 100644 index 0000000..be02253 --- /dev/null +++ b/api/CommentatorSetTargetHeightOffset.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CommentatorSetTargetHeightOffset() end \ No newline at end of file diff --git a/api/CommentatorStartWargame.lua b/api/CommentatorStartWargame.lua new file mode 100644 index 0000000..413c1c0 --- /dev/null +++ b/api/CommentatorStartWargame.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CommentatorStartWargame() end \ No newline at end of file diff --git a/api/CommentatorToggleMode.lua b/api/CommentatorToggleMode.lua new file mode 100644 index 0000000..8cc8e76 --- /dev/null +++ b/api/CommentatorToggleMode.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CommentatorToggleMode() end \ No newline at end of file diff --git a/api/CommentatorUpdateMapInfo.lua b/api/CommentatorUpdateMapInfo.lua new file mode 100644 index 0000000..61c918c --- /dev/null +++ b/api/CommentatorUpdateMapInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CommentatorUpdateMapInfo() end \ No newline at end of file diff --git a/api/CommentatorUpdatePlayerInfo.lua b/api/CommentatorUpdatePlayerInfo.lua new file mode 100644 index 0000000..697dd5d --- /dev/null +++ b/api/CommentatorUpdatePlayerInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CommentatorUpdatePlayerInfo() end \ No newline at end of file diff --git a/api/CommentatorZoomIn.lua b/api/CommentatorZoomIn.lua new file mode 100644 index 0000000..96aa9a8 --- /dev/null +++ b/api/CommentatorZoomIn.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CommentatorZoomIn() end \ No newline at end of file diff --git a/api/CommentatorZoomOut.lua b/api/CommentatorZoomOut.lua new file mode 100644 index 0000000..03d9291 --- /dev/null +++ b/api/CommentatorZoomOut.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CommentatorZoomOut() end \ No newline at end of file diff --git a/api/ComplainInboxItem.lua b/api/ComplainInboxItem.lua new file mode 100644 index 0000000..4df3a0a --- /dev/null +++ b/api/ComplainInboxItem.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param mailID number +---Reports a mail as spam +function ComplainInboxItem(mailID) end \ No newline at end of file diff --git a/api/CompleteLFGRoleCheck.lua b/api/CompleteLFGRoleCheck.lua new file mode 100644 index 0000000..a4c0df5 --- /dev/null +++ b/api/CompleteLFGRoleCheck.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CompleteLFGRoleCheck() end \ No newline at end of file diff --git a/api/CompleteQuest.lua b/api/CompleteQuest.lua new file mode 100644 index 0000000..de28f36 --- /dev/null +++ b/api/CompleteQuest.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Begins turning in a quest to a questgiver. Usable following the QUEST_PROGRESS event in which it is determined whether the player can complete the quest. Does not complete the quest turn-in process; after calling this function, the QUEST_COMPLETE event fires as the questgiver presents rewards (or sometimes only closure to the quest narrative); following that event, the GetQuestReward() function finishes the turn-in. +function CompleteQuest() end \ No newline at end of file diff --git a/api/ConfirmAcceptQuest.lua b/api/ConfirmAcceptQuest.lua new file mode 100644 index 0000000..79aca53 --- /dev/null +++ b/api/ConfirmAcceptQuest.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Accepts a quest started by another group member. Usable following the QUEST_ACCEPT_CONFIRM event which fires when another member of the player's party or raid starts certain quests (e.g. escort quests). +function ConfirmAcceptQuest() end \ No newline at end of file diff --git a/api/ConfirmBindOnUse.lua b/api/ConfirmBindOnUse.lua new file mode 100644 index 0000000..2bb244b --- /dev/null +++ b/api/ConfirmBindOnUse.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Confirms using an item, if using the item causes it to become soulbound. Usable in response to the USE_BIND_CONFIRM which fires when the player attempts to use a "Bind on Use" item. +function ConfirmBindOnUse() end \ No newline at end of file diff --git a/api/ConfirmBinder.lua b/api/ConfirmBinder.lua new file mode 100644 index 0000000..2a5c3ba --- /dev/null +++ b/api/ConfirmBinder.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Sets the player's Hearthstone to the current location. Usable in response to the CONFIRM_BINDER event which fires upon speaking to an Innkeeper (or similar NPC) and choosing the Hearthstone option. +function ConfirmBinder() end \ No newline at end of file diff --git a/api/ConfirmLootRoll.lua b/api/ConfirmLootRoll.lua new file mode 100644 index 0000000..a9251c9 --- /dev/null +++ b/api/ConfirmLootRoll.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@param rollType 2 +---@param 0 +---@param 1 +---@param 2 +---Confirms the player's intent regarding an item up for loot rolling. Usable after the CONFIRM_LOOT_ROLL event fires, warning that an item binds on pickup. +function ConfirmLootRoll(id, rollType, 0, 1, 2) end \ No newline at end of file diff --git a/api/ConfirmLootSlot.lua b/api/ConfirmLootSlot.lua new file mode 100644 index 0000000..2f75f16 --- /dev/null +++ b/api/ConfirmLootSlot.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---Confirms picking up an item available as loot. Usable after the LOOT_BIND_CONFIRM event fires, warning that an item binds on pickup. +function ConfirmLootSlot(slot) end \ No newline at end of file diff --git a/api/ConfirmReadyCheck.lua b/api/ConfirmReadyCheck.lua new file mode 100644 index 0000000..19a7c27 --- /dev/null +++ b/api/ConfirmReadyCheck.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param ready true +---Responds to a ready check +function ConfirmReadyCheck(ready) end \ No newline at end of file diff --git a/api/ConfirmSummon.lua b/api/ConfirmSummon.lua new file mode 100644 index 0000000..7be947b --- /dev/null +++ b/api/ConfirmSummon.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Accepts an offered summons, teleporting the player to the summoner's location. Usable between when the CONFIRM_SUMMON event fires (due to a summoning spell cast by another player) and when the value returned by GetSummonConfirmTimeLeft() reaches zero. +function ConfirmSummon() end \ No newline at end of file diff --git a/api/ConfirmTalentWipe.lua b/api/ConfirmTalentWipe.lua new file mode 100644 index 0000000..f8ba713 --- /dev/null +++ b/api/ConfirmTalentWipe.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Resets the player's talents. Usable following the CONFIRM_TALENT_WIPE event which fires when the player speaks to an trainer NPC and chooses to reset his or her talents. +function ConfirmTalentWipe() end \ No newline at end of file diff --git a/api/ConsoleAddMessage.lua b/api/ConsoleAddMessage.lua new file mode 100644 index 0000000..238fbb5 --- /dev/null +++ b/api/ConsoleAddMessage.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Prints text to the debug console. The debugging console can be activated by launching WoW from the command line with the "-console" option, then pressing the "`" (backtick/tilde) key ingame. Its usefulness outside of Blizzard internal environments is limited. +function ConsoleAddMessage() end \ No newline at end of file diff --git a/api/ConsoleExec.lua b/api/ConsoleExec.lua new file mode 100644 index 0000000..7586a58 --- /dev/null +++ b/api/ConsoleExec.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param console_command string +---Runs a console command. Used by the default UI to handle /console commands. +function ConsoleExec(console_command) end \ No newline at end of file diff --git a/api/ContainerIDToInventoryID.lua b/api/ContainerIDToInventoryID.lua new file mode 100644 index 0000000..6abaaea --- /dev/null +++ b/api/ContainerIDToInventoryID.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param container number +---@return number inventoryID +---Returns the inventoryID corresponding to a given containerID. The results of this function can be used with GetInventorySlotInfo() and other related inventory functions. It seemingly does not work with containers that are considered special, like backpack, bank or reagent bank (anymore?)! Calling this method for those containerIDs will result in an "invalid container ID" error. +function ContainerIDToInventoryID(container) end \ No newline at end of file diff --git a/api/ContainerRefundItemPurchase.lua b/api/ContainerRefundItemPurchase.lua new file mode 100644 index 0000000..1aefa7f --- /dev/null +++ b/api/ContainerRefundItemPurchase.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param container number +---@param slot number +---Sells an item purchased with alternate currency back to a vendor. Items bought with alternate currency (honor points, arena points, or special items such as Emblems of Heroism and Dalaran Cooking Awards) can be returned to a vendor for a full refund, but only within a limited time after the original purchase. +function ContainerRefundItemPurchase(container, slot) end \ No newline at end of file diff --git a/api/ConvertToParty.lua b/api/ConvertToParty.lua new file mode 100644 index 0000000..054f7a3 --- /dev/null +++ b/api/ConvertToParty.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Converts a raid to a party. Only has effect if the player is in a raid of a maximum of 5 players and is the raid leader. +function ConvertToParty() end \ No newline at end of file diff --git a/api/ConvertToRaid.lua b/api/ConvertToRaid.lua new file mode 100644 index 0000000..95e65b4 --- /dev/null +++ b/api/ConvertToRaid.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Converts a party to a raid. Only has effect if the player is in a party and the party leader. +function ConvertToRaid() end \ No newline at end of file diff --git a/api/CreateFont.lua b/api/CreateFont.lua new file mode 100644 index 0000000..2c0f329 --- /dev/null +++ b/api/CreateFont.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@return table fontObject +---Creates a new Font object +function CreateFont(name) end \ No newline at end of file diff --git a/api/CreateFrame.lua b/api/CreateFrame.lua new file mode 100644 index 0000000..7ff908f --- /dev/null +++ b/api/CreateFrame.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param frameType string +---@param name string +---@param parent table +---@param template string +---@return table frame +---Creates a new Frame object +function CreateFrame(frameType, name, parent, template) end \ No newline at end of file diff --git a/api/CreateMacro.lua b/api/CreateMacro.lua new file mode 100644 index 0000000..97bc96e --- /dev/null +++ b/api/CreateMacro.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param iconTexture string +---@param body string +---@param perCharacter 1nil +---@return number index +---Creates a new macro. Warning: Will throw an error if the quota of allowed macros is already met. +function CreateMacro(name, iconTexture, body, perCharacter) end \ No newline at end of file diff --git a/api/CreateNewRaidProfile.lua b/api/CreateNewRaidProfile.lua new file mode 100644 index 0000000..05316d0 --- /dev/null +++ b/api/CreateNewRaidProfile.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function CreateNewRaidProfile() end \ No newline at end of file diff --git a/api/CursorCanGoInSlot.lua b/api/CursorCanGoInSlot.lua new file mode 100644 index 0000000..650ebb5 --- /dev/null +++ b/api/CursorCanGoInSlot.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return 1nil canBePlaced +---Returns whether the item on the cursor can be equipped in an inventory slot. Returns nil if the cursor is empty or contains something other than an item. +function CursorCanGoInSlot(slot) end \ No newline at end of file diff --git a/api/CursorHasItem.lua b/api/CursorHasItem.lua new file mode 100644 index 0000000..aaa103e --- /dev/null +++ b/api/CursorHasItem.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil hasItem +---Returns whether an item belonging to the player is on the cursor. See GetCursorInfo() for more detailed information. +function CursorHasItem() end \ No newline at end of file diff --git a/api/CursorHasMacro.lua b/api/CursorHasMacro.lua new file mode 100644 index 0000000..9861c88 --- /dev/null +++ b/api/CursorHasMacro.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil hasMacro +---Returns whether a macro is on the cursor. See GetCursorInfo() for more detailed information. +function CursorHasMacro() end \ No newline at end of file diff --git a/api/CursorHasMoney.lua b/api/CursorHasMoney.lua new file mode 100644 index 0000000..bac6a36 --- /dev/null +++ b/api/CursorHasMoney.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil hasMoney +---Returns whether an amount of the player's money is on the cursor. Returns nil if the cursor holds guild bank money. See GetCursorInfo() for more detailed information. +function CursorHasMoney() end \ No newline at end of file diff --git a/api/CursorHasSpell.lua b/api/CursorHasSpell.lua new file mode 100644 index 0000000..77c3154 --- /dev/null +++ b/api/CursorHasSpell.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil hasSpell +---Returns whether a spell is on the cursor. See GetCursorInfo() for more detailed information. +function CursorHasSpell() end \ No newline at end of file diff --git a/api/DeclineChannelInvite.lua b/api/DeclineChannelInvite.lua new file mode 100644 index 0000000..11878f3 --- /dev/null +++ b/api/DeclineChannelInvite.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function DeclineChannelInvite() end \ No newline at end of file diff --git a/api/DeclineGroup.lua b/api/DeclineGroup.lua new file mode 100644 index 0000000..580c440 --- /dev/null +++ b/api/DeclineGroup.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Declines an invitation to join a party or raid. Usable in response to the PARTY_INVITE_REQUEST event which fires when the player is invited to join a group. +function DeclineGroup() end \ No newline at end of file diff --git a/api/DeclineGuild.lua b/api/DeclineGuild.lua new file mode 100644 index 0000000..5435398 --- /dev/null +++ b/api/DeclineGuild.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Declines an offered guild invitation. Usable in response to the GUILD_INVITE_REQUEST event which fires when the player is invited to join a guild. +function DeclineGuild() end \ No newline at end of file diff --git a/api/DeclineGuildApplicant.lua b/api/DeclineGuildApplicant.lua new file mode 100644 index 0000000..7342081 --- /dev/null +++ b/api/DeclineGuildApplicant.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function DeclineGuildApplicant() end \ No newline at end of file diff --git a/api/DeclineLevelGrant.lua b/api/DeclineLevelGrant.lua new file mode 100644 index 0000000..9f475cc --- /dev/null +++ b/api/DeclineLevelGrant.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Refuses a level offered by the player's Recruit-a-Friend partner +function DeclineLevelGrant() end \ No newline at end of file diff --git a/api/DeclineName.lua b/api/DeclineName.lua new file mode 100644 index 0000000..6b15ce2 --- /dev/null +++ b/api/DeclineName.lua @@ -0,0 +1,15 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param gender 3 +---@param 1or nil +---@param 2 +---@param 3 +---@param declensionSet number +---@return string genitive +---@return string dative +---@return string accusative +---@return string instrumental +---@return string prepositional +---Returns suggested declensions for a name. In the Russian language, nouns (including proper names) take different form based on their usage in a sentence. When the player enters the base name for a character or pet, the game suggests one or more sets of variations for the five additional cases; the player is asked to choose from among the suggestions and/or enter their own. (The set of declensions ultimately chosen/entered by the player are only used internally and not available to addons.) Has no effect in non-Russian-localized clients. +function DeclineName(name, gender, 1or nil, 2, 3, declensionSet) end \ No newline at end of file diff --git a/api/DeclineQuest.lua b/api/DeclineQuest.lua new file mode 100644 index 0000000..97fc989 --- /dev/null +++ b/api/DeclineQuest.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Declines a quest.. Usable following the QUEST_DETAIL event in which the questgiver presents the player with the details of a quest and the option to accept or decline. +function DeclineQuest() end \ No newline at end of file diff --git a/api/DeclineResurrect.lua b/api/DeclineResurrect.lua new file mode 100644 index 0000000..f342bdd --- /dev/null +++ b/api/DeclineResurrect.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Declines an offered resurrection spell. Usable following the RESURRECT_REQUEST event which fires when the player is offered resurrection by another unit. +function DeclineResurrect() end \ No newline at end of file diff --git a/api/DeclineSpellConfirmationPrompt.lua b/api/DeclineSpellConfirmationPrompt.lua new file mode 100644 index 0000000..f04e45e --- /dev/null +++ b/api/DeclineSpellConfirmationPrompt.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function DeclineSpellConfirmationPrompt() end \ No newline at end of file diff --git a/api/DelIgnore.lua b/api/DelIgnore.lua new file mode 100644 index 0000000..e94ec99 --- /dev/null +++ b/api/DelIgnore.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---Removes a player from the ignore list +function DelIgnore(name) end \ No newline at end of file diff --git a/api/DelMute.lua b/api/DelMute.lua new file mode 100644 index 0000000..3b4c0cb --- /dev/null +++ b/api/DelMute.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---Removes a character from the muted list for voice chat. The Muted list acts for voice chat as the Ignore list does for text chat: muted characters will never be heard regardless of which voice channels they join the player in. +function DelMute(name) end \ No newline at end of file diff --git a/api/DeleteCursorItem.lua b/api/DeleteCursorItem.lua new file mode 100644 index 0000000..7f8d5a6 --- /dev/null +++ b/api/DeleteCursorItem.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Destroys the item on the cursor. Used in the default UI when accepting the confirmation prompt that appears when dragging and dropping an item to an empty area of the screen. +function DeleteCursorItem() end \ No newline at end of file diff --git a/api/DeleteEquipmentSet.lua b/api/DeleteEquipmentSet.lua new file mode 100644 index 0000000..7164e34 --- /dev/null +++ b/api/DeleteEquipmentSet.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---Deletes an equipment set +function DeleteEquipmentSet(name) end \ No newline at end of file diff --git a/api/DeleteGMTicket.lua b/api/DeleteGMTicket.lua new file mode 100644 index 0000000..7d5a457 --- /dev/null +++ b/api/DeleteGMTicket.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Abandons the currently pending GM ticket +function DeleteGMTicket() end \ No newline at end of file diff --git a/api/DeleteInboxItem.lua b/api/DeleteInboxItem.lua new file mode 100644 index 0000000..c01984f --- /dev/null +++ b/api/DeleteInboxItem.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param mailID number +---Deletes a mail from the player's inbox +function DeleteInboxItem(mailID) end \ No newline at end of file diff --git a/api/DeleteMacro.lua b/api/DeleteMacro.lua new file mode 100644 index 0000000..8581f51 --- /dev/null +++ b/api/DeleteMacro.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param name string +---Deletes a macro +function DeleteMacro(index, name) end \ No newline at end of file diff --git a/api/DeleteRaidProfile.lua b/api/DeleteRaidProfile.lua new file mode 100644 index 0000000..ed09dc9 --- /dev/null +++ b/api/DeleteRaidProfile.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function DeleteRaidProfile() end \ No newline at end of file diff --git a/api/DemoteAssistant.lua b/api/DemoteAssistant.lua new file mode 100644 index 0000000..de7ab80 --- /dev/null +++ b/api/DemoteAssistant.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@param exactMatch boolean +---Demotes the given player from raid assistant status +function DemoteAssistant(unit, name, exactMatch) end \ No newline at end of file diff --git a/api/DepositGuildBankMoney.lua b/api/DepositGuildBankMoney.lua new file mode 100644 index 0000000..dbecf5c --- /dev/null +++ b/api/DepositGuildBankMoney.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param money number +---Deposits money into the guild bank +function DepositGuildBankMoney(money) end \ No newline at end of file diff --git a/api/DepositReagentBank.lua b/api/DepositReagentBank.lua new file mode 100644 index 0000000..e07b7eb --- /dev/null +++ b/api/DepositReagentBank.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Deposits Reagents in to Reagent Bank +function DepositReagentBank() end \ No newline at end of file diff --git a/api/DescendStop.lua b/api/DescendStop.lua new file mode 100644 index 0000000..fc16eb6 --- /dev/null +++ b/api/DescendStop.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Stops movement initiated by SitStandOrDescendStart. Used by the SITORSTAND binding, which also controls descent when swimming or flying. Has no meaningful effect if called while sitting/standing. +function DescendStop() end \ No newline at end of file diff --git a/api/DestroyTotem.lua b/api/DestroyTotem.lua new file mode 100644 index 0000000..d4aa95c --- /dev/null +++ b/api/DestroyTotem.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot 4 +---@param 1 +---@param 2 +---@param 3 +---@param 4 +---Destroys a specific totem (or ghoul). Totem functions are also used for ghouls summoned by a Death Knight's Raise Dead ability (if the ghoul is not made a controllable pet by the Master of Ghouls talent). +function DestroyTotem(slot, 1, 2, 3, 4) end \ No newline at end of file diff --git a/api/DetectWowMouse.lua b/api/DetectWowMouse.lua new file mode 100644 index 0000000..8c9ad3e --- /dev/null +++ b/api/DetectWowMouse.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Detects the presence of a "WoW" compatible multi-button mouse. This function is used by the default user interface to enable or disable the configuration option for a many buttoned WoW mouse. If the mouse is not found, the WOW_MOUSE_NOT_FOUND event will fire. +function DetectWowMouse() end \ No newline at end of file diff --git a/api/DisableAddOn.lua b/api/DisableAddOn.lua new file mode 100644 index 0000000..4804a98 --- /dev/null +++ b/api/DisableAddOn.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param index number +---@param character string +---Marks an addon as disabled. The addon will remain active until the player logs out and back in or reloads the UI (see ReloadUI()). Changes to the enabled/disabled state of addons while in-game are saved on a per-character basis. +function DisableAddOn(name, index, character) end \ No newline at end of file diff --git a/api/DisableAllAddOns.lua b/api/DisableAllAddOns.lua new file mode 100644 index 0000000..2ac2127 --- /dev/null +++ b/api/DisableAllAddOns.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param character string +---Marks all addons as disabled. Addons will remain active until the player logs out and back in or reloads the UI (see ReloadUI()). Changes to the enabled/disabled state of addons while in-game are saved on a per-character basis. +function DisableAllAddOns(character) end \ No newline at end of file diff --git a/api/DisableSpellAutocast.lua b/api/DisableSpellAutocast.lua new file mode 100644 index 0000000..6c6180e --- /dev/null +++ b/api/DisableSpellAutocast.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param spell string +---Disables automatic casting of a pet spell +function DisableSpellAutocast(spell) end \ No newline at end of file diff --git a/api/DismissCompanion.lua b/api/DismissCompanion.lua new file mode 100644 index 0000000..c1f3f1f --- /dev/null +++ b/api/DismissCompanion.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param type MOUNT +---@param CRITTER +---@param MOUNT +---Unsummons the current non-combat pet or mount +function DismissCompanion(type, CRITTER, MOUNT) end \ No newline at end of file diff --git a/api/Dismount.lua b/api/Dismount.lua new file mode 100644 index 0000000..c5172f6 --- /dev/null +++ b/api/Dismount.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Dismounts from the player's summoned mount +function Dismount() end \ No newline at end of file diff --git a/api/DisplayChannelOwner.lua b/api/DisplayChannelOwner.lua new file mode 100644 index 0000000..f474c31 --- /dev/null +++ b/api/DisplayChannelOwner.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param channel string +---@param channelIndex number +---Requests information from the server about a channel's owner. Fires the CHANNEL_OWNER event indicating the name of the channel owner. +function DisplayChannelOwner(channel, channelIndex) end \ No newline at end of file diff --git a/api/DisplayChannelVoiceOff.lua b/api/DisplayChannelVoiceOff.lua new file mode 100644 index 0000000..fe1b5bc --- /dev/null +++ b/api/DisplayChannelVoiceOff.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Disables voice in a channel specified by its position in the channel list display +function DisplayChannelVoiceOff(index) end \ No newline at end of file diff --git a/api/DisplayChannelVoiceOn.lua b/api/DisplayChannelVoiceOn.lua new file mode 100644 index 0000000..763b2ab --- /dev/null +++ b/api/DisplayChannelVoiceOn.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Enables voice in a channel specified by its position in the channel list display +function DisplayChannelVoiceOn(index) end \ No newline at end of file diff --git a/api/DoEmote.lua b/api/DoEmote.lua new file mode 100644 index 0000000..27ef432 --- /dev/null +++ b/api/DoEmote.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param emote string +---@param target string +---@param hold boolean +---Performs a preset emote (with optional target). The list of built-in emote tokens can be found in global variables whose names follow the format "EMOTE"..num.."_TOKEN", where num is a number between 1 and MAXEMOTEINDEX (a variable local to ChatFrame.lua.) For custom emotes (as performed using the /emote or /me commands in the default UI), see SendChatMessage(). +function DoEmote(emote, target, hold) end \ No newline at end of file diff --git a/api/DoMasterLootRoll.lua b/api/DoMasterLootRoll.lua new file mode 100644 index 0000000..c20324a --- /dev/null +++ b/api/DoMasterLootRoll.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function DoMasterLootRoll() end \ No newline at end of file diff --git a/api/DoReadyCheck.lua b/api/DoReadyCheck.lua new file mode 100644 index 0000000..ca9ea68 --- /dev/null +++ b/api/DoReadyCheck.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Initiates a ready check. Only has effect if the player is the party/raid leader or a raid assistant. +function DoReadyCheck() end \ No newline at end of file diff --git a/api/DoTradeSkill.lua b/api/DoTradeSkill.lua new file mode 100644 index 0000000..0a9f85d --- /dev/null +++ b/api/DoTradeSkill.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param repeat number +---Performs a trade skill recipe +function DoTradeSkill(index, repeat) end \ No newline at end of file diff --git a/api/DropCursorMoney.lua b/api/DropCursorMoney.lua new file mode 100644 index 0000000..e42e996 --- /dev/null +++ b/api/DropCursorMoney.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Drops any money currently on the cursor, returning it to where it was taken from +function DropCursorMoney() end \ No newline at end of file diff --git a/api/DropItemOnUnit.lua b/api/DropItemOnUnit.lua new file mode 100644 index 0000000..83b2af1 --- /dev/null +++ b/api/DropItemOnUnit.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---"Gives" the item on the cursor to another unit; results vary by context. If the unit is a friendly player, adds the item to the trade window (opening it if necessary, and placing it in the first available trade slot or the "will not be traded" slot depending on whether the item is soulbound). If the unit is the player's pet and the player is a Hunter, attempts to feed the item to the pet (since this casts the Feed Pet spell, in this case this action is protected and can only be called by the Blizzard user interface). For other units, nothing happens and the item remains on the cursor. +function DropItemOnUnit(unit, name) end \ No newline at end of file diff --git a/api/DungeonUsesTerrainMap.lua b/api/DungeonUsesTerrainMap.lua new file mode 100644 index 0000000..aec438b --- /dev/null +++ b/api/DungeonUsesTerrainMap.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function DungeonUsesTerrainMap() end \ No newline at end of file diff --git a/api/EJ_ClearSearch.lua b/api/EJ_ClearSearch.lua new file mode 100644 index 0000000..0ac9930 --- /dev/null +++ b/api/EJ_ClearSearch.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function EJ_ClearSearch() end \ No newline at end of file diff --git a/api/EJ_GetCreatureInfo.lua b/api/EJ_GetCreatureInfo.lua new file mode 100644 index 0000000..0b3b8bf --- /dev/null +++ b/api/EJ_GetCreatureInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function EJ_GetCreatureInfo() end \ No newline at end of file diff --git a/api/EJ_GetCurrentInstance.lua b/api/EJ_GetCurrentInstance.lua new file mode 100644 index 0000000..49fd249 --- /dev/null +++ b/api/EJ_GetCurrentInstance.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function EJ_GetCurrentInstance() end \ No newline at end of file diff --git a/api/EJ_GetCurrentTier.lua b/api/EJ_GetCurrentTier.lua new file mode 100644 index 0000000..abbb0ff --- /dev/null +++ b/api/EJ_GetCurrentTier.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function EJ_GetCurrentTier() end \ No newline at end of file diff --git a/api/EJ_GetDifficulty.lua b/api/EJ_GetDifficulty.lua new file mode 100644 index 0000000..3beef18 --- /dev/null +++ b/api/EJ_GetDifficulty.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function EJ_GetDifficulty() end \ No newline at end of file diff --git a/api/EJ_GetEncounterInfo.lua b/api/EJ_GetEncounterInfo.lua new file mode 100644 index 0000000..91a9c5e --- /dev/null +++ b/api/EJ_GetEncounterInfo.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param encounterID number +---@return string name +---@return string description +---@return number encounterID +---@return number firstSection +---@return string encounterLink +---Displays encounter journal information for the encounter. +function EJ_GetEncounterInfo(encounterID) end \ No newline at end of file diff --git a/api/EJ_GetEncounterInfoByIndex.lua b/api/EJ_GetEncounterInfoByIndex.lua new file mode 100644 index 0000000..3df93ce --- /dev/null +++ b/api/EJ_GetEncounterInfoByIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function EJ_GetEncounterInfoByIndex() end \ No newline at end of file diff --git a/api/EJ_GetInstanceByIndex.lua b/api/EJ_GetInstanceByIndex.lua new file mode 100644 index 0000000..0e2cc59 --- /dev/null +++ b/api/EJ_GetInstanceByIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function EJ_GetInstanceByIndex() end \ No newline at end of file diff --git a/api/EJ_GetInstanceInfo.lua b/api/EJ_GetInstanceInfo.lua new file mode 100644 index 0000000..d6fe702 --- /dev/null +++ b/api/EJ_GetInstanceInfo.lua @@ -0,0 +1,13 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param instanceID number +---@return string instanceName +---@return string instanceDesc +---@return string backgroundTexture +---@return string buttonTexture +---@return string titleBackground +---@return string iconTexture +---@return number mapID +---@return string instanceLink +---Returns information about an instance used by the Dungeon Journal. +function EJ_GetInstanceInfo(instanceID) end \ No newline at end of file diff --git a/api/EJ_GetLootFilter.lua b/api/EJ_GetLootFilter.lua new file mode 100644 index 0000000..00d5eec --- /dev/null +++ b/api/EJ_GetLootFilter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function EJ_GetLootFilter() end \ No newline at end of file diff --git a/api/EJ_GetLootInfo.lua b/api/EJ_GetLootInfo.lua new file mode 100644 index 0000000..0d698a1 --- /dev/null +++ b/api/EJ_GetLootInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function EJ_GetLootInfo() end \ No newline at end of file diff --git a/api/EJ_GetLootInfoByIndex.lua b/api/EJ_GetLootInfoByIndex.lua new file mode 100644 index 0000000..1c1c794 --- /dev/null +++ b/api/EJ_GetLootInfoByIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function EJ_GetLootInfoByIndex() end \ No newline at end of file diff --git a/api/EJ_GetMapEncounter.lua b/api/EJ_GetMapEncounter.lua new file mode 100644 index 0000000..517068c --- /dev/null +++ b/api/EJ_GetMapEncounter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function EJ_GetMapEncounter() end \ No newline at end of file diff --git a/api/EJ_GetNumLoot.lua b/api/EJ_GetNumLoot.lua new file mode 100644 index 0000000..3a3e235 --- /dev/null +++ b/api/EJ_GetNumLoot.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function EJ_GetNumLoot() end \ No newline at end of file diff --git a/api/EJ_GetNumSearchResults.lua b/api/EJ_GetNumSearchResults.lua new file mode 100644 index 0000000..c5181fa --- /dev/null +++ b/api/EJ_GetNumSearchResults.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function EJ_GetNumSearchResults() end \ No newline at end of file diff --git a/api/EJ_GetNumTiers.lua b/api/EJ_GetNumTiers.lua new file mode 100644 index 0000000..06adde2 --- /dev/null +++ b/api/EJ_GetNumTiers.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function EJ_GetNumTiers() end \ No newline at end of file diff --git a/api/EJ_GetSearchResult.lua b/api/EJ_GetSearchResult.lua new file mode 100644 index 0000000..1fdd696 --- /dev/null +++ b/api/EJ_GetSearchResult.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function EJ_GetSearchResult() end \ No newline at end of file diff --git a/api/EJ_GetSectionInfo.lua b/api/EJ_GetSectionInfo.lua new file mode 100644 index 0000000..ac6c397 --- /dev/null +++ b/api/EJ_GetSectionInfo.lua @@ -0,0 +1,36 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param sectionID number +---@return string name +---@return string description +---@return 4 headerType +---@return 0 +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---@return string abilityIcon +---@return number displayInfo +---@return number siblingID +---@return number nextSectionID +---@return boolean fileredByDifficulty +---@return string sectionLink +---@return boolean startsOpen +---@return 11 flag1 +---@return 0 +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---@return 5 +---@return 6 +---@return 7 +---@return 8 +---@return 9 +---@return 10 +---@return 11 +---@return number flag2 +---@return number flag3 +---@return number flag4 +---Returns information regarding a "section" of the encounter journal. A "section" is a phase, unit or ability of an encounter. +function EJ_GetSectionInfo(sectionID) end \ No newline at end of file diff --git a/api/EJ_GetSectionPath.lua b/api/EJ_GetSectionPath.lua new file mode 100644 index 0000000..1d6ce35 --- /dev/null +++ b/api/EJ_GetSectionPath.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function EJ_GetSectionPath() end \ No newline at end of file diff --git a/api/EJ_GetTierInfo.lua b/api/EJ_GetTierInfo.lua new file mode 100644 index 0000000..ff3c683 --- /dev/null +++ b/api/EJ_GetTierInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function EJ_GetTierInfo() end \ No newline at end of file diff --git a/api/EJ_HandleLinkPath.lua b/api/EJ_HandleLinkPath.lua new file mode 100644 index 0000000..6a7c3e5 --- /dev/null +++ b/api/EJ_HandleLinkPath.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function EJ_HandleLinkPath() end \ No newline at end of file diff --git a/api/EJ_InstanceIsRaid.lua b/api/EJ_InstanceIsRaid.lua new file mode 100644 index 0000000..382abc1 --- /dev/null +++ b/api/EJ_InstanceIsRaid.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function EJ_InstanceIsRaid() end \ No newline at end of file diff --git a/api/EJ_IsValidInstanceDifficulty.lua b/api/EJ_IsValidInstanceDifficulty.lua new file mode 100644 index 0000000..346bd89 --- /dev/null +++ b/api/EJ_IsValidInstanceDifficulty.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function EJ_IsValidInstanceDifficulty() end \ No newline at end of file diff --git a/api/EJ_ResetLootFilter.lua b/api/EJ_ResetLootFilter.lua new file mode 100644 index 0000000..9bc2b78 --- /dev/null +++ b/api/EJ_ResetLootFilter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function EJ_ResetLootFilter() end \ No newline at end of file diff --git a/api/EJ_SelectEncounter.lua b/api/EJ_SelectEncounter.lua new file mode 100644 index 0000000..1b4aab1 --- /dev/null +++ b/api/EJ_SelectEncounter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function EJ_SelectEncounter() end \ No newline at end of file diff --git a/api/EJ_SelectInstance.lua b/api/EJ_SelectInstance.lua new file mode 100644 index 0000000..362c3e2 --- /dev/null +++ b/api/EJ_SelectInstance.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function EJ_SelectInstance() end \ No newline at end of file diff --git a/api/EJ_SelectTier.lua b/api/EJ_SelectTier.lua new file mode 100644 index 0000000..dd76a75 --- /dev/null +++ b/api/EJ_SelectTier.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function EJ_SelectTier() end \ No newline at end of file diff --git a/api/EJ_SetDifficulty.lua b/api/EJ_SetDifficulty.lua new file mode 100644 index 0000000..372886c --- /dev/null +++ b/api/EJ_SetDifficulty.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param difficulty number +---Set the dungeon difficulty of the Encounter Journal. List op usable IDs: 1: (5) Normal 2: (5) Heroic 3: (10) Normal 4: (25) Normal 5: (10) Heroic 6: (25) Heroic 7: (25) Raid Finder 14: Normal 15: Heroic 16: Mythic 17: Raid Finder 23: (5) Mythic 24: (5) Timewalking +function EJ_SetDifficulty(difficulty) end \ No newline at end of file diff --git a/api/EJ_SetLootFilter.lua b/api/EJ_SetLootFilter.lua new file mode 100644 index 0000000..8801f75 --- /dev/null +++ b/api/EJ_SetLootFilter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function EJ_SetLootFilter() end \ No newline at end of file diff --git a/api/EJ_SetSearch.lua b/api/EJ_SetSearch.lua new file mode 100644 index 0000000..012275b --- /dev/null +++ b/api/EJ_SetSearch.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function EJ_SetSearch() end \ No newline at end of file diff --git a/api/EditMacro.lua b/api/EditMacro.lua new file mode 100644 index 0000000..1f4f2c7 --- /dev/null +++ b/api/EditMacro.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param name string +---@param iconTexture string +---@param body string +---@return number newIndex +---Changes the name, icon, and/or body of a macro. After patch 4.3 then the numeric 'icon' argument has been replaced by 'iconTexture'. Furthermore, the function always prepend 'Interface\Icons' to the 'iconTexture' string. +function EditMacro(index, name, iconTexture, body) end \ No newline at end of file diff --git a/api/EjectPassengerFromSeat.lua b/api/EjectPassengerFromSeat.lua new file mode 100644 index 0000000..2f185a3 --- /dev/null +++ b/api/EjectPassengerFromSeat.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param seat number +---Ejects the occupant of a seat in the player's vehicle +function EjectPassengerFromSeat(seat) end \ No newline at end of file diff --git a/api/EnableAddOn.lua b/api/EnableAddOn.lua new file mode 100644 index 0000000..491cbb9 --- /dev/null +++ b/api/EnableAddOn.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param name string +---@param character string +---Marks an addon as enabled. The addon will remain inactive until the player logs out and back in or reloads the UI (see ReloadUI()). Changes to the enabled/disabled state of addons while in-game are saved on a per-character basis. +function EnableAddOn(index, name, character) end \ No newline at end of file diff --git a/api/EnableAllAddOns.lua b/api/EnableAllAddOns.lua new file mode 100644 index 0000000..cbf4e68 --- /dev/null +++ b/api/EnableAllAddOns.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param character string +---Marks all addons as enabled. Addons will remain inactive until the player logs out and back in or reloads the UI (see ReloadUI()). Changes to the enabled/disabled state of addons while in-game are saved on a per-character basis. +function EnableAllAddOns(character) end \ No newline at end of file diff --git a/api/EnableSpellAutocast.lua b/api/EnableSpellAutocast.lua new file mode 100644 index 0000000..6aff11f --- /dev/null +++ b/api/EnableSpellAutocast.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param spell string +---Enables automatic casting of a pet spell +function EnableSpellAutocast(spell) end \ No newline at end of file diff --git a/api/EndBoundTradeable.lua b/api/EndBoundTradeable.lua new file mode 100644 index 0000000..241a5c7 --- /dev/null +++ b/api/EndBoundTradeable.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---Confirms taking an action which renders a looted Bind on Pickup item non-tradeable. A Bind on Pickup item looted by the player can be traded to other characters who were originally eligible to loot it, but only within a limited time after looting. This period can be ended prematurely if the player attempts certain actions (such as enchanting the item). +function EndBoundTradeable(id) end \ No newline at end of file diff --git a/api/EndRefund.lua b/api/EndRefund.lua new file mode 100644 index 0000000..066588b --- /dev/null +++ b/api/EndRefund.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---Confirms taking an action which renders a purchased item non-refundable. Items bought with alternate currency (honor points, arena points, or special items such as Emblems of Heroism and Dalaran Cooking Awards) can be returned to a vendor for a full refund, but only within a limited time after the original purchase. This period can be ended prematurely if the player attempts certain actions (such as enchanting the item). +function EndRefund(id) end \ No newline at end of file diff --git a/api/EnumerateFrames.lua b/api/EnumerateFrames.lua new file mode 100644 index 0000000..f03f1e4 --- /dev/null +++ b/api/EnumerateFrames.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param currentFrame table +---@return table nextFrame +---Returns the next frame following the frame passed, or nil if no more frames exist +function EnumerateFrames(currentFrame) end \ No newline at end of file diff --git a/api/EnumerateServerChannels.lua b/api/EnumerateServerChannels.lua new file mode 100644 index 0000000..6a0f9ae --- /dev/null +++ b/api/EnumerateServerChannels.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string ... +---Returns the available server channel names +function EnumerateServerChannels() end \ No newline at end of file diff --git a/api/EquipCursorItem.lua b/api/EquipCursorItem.lua new file mode 100644 index 0000000..11194f2 --- /dev/null +++ b/api/EquipCursorItem.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---Puts the item on the cursor into a specific equipment slot. If the item on the cursor can be equipped but does not fit in the given slot, the item is automatically equipped in the first available slot in which it fits (as with AutoEquipCursorItem()). Thus, this function is most useful when dealing with items which can be equipped in more than one slot: containers, rings, trinkets, and (for dual-wielding characters) one-handed weapons. Causes an error message (UI_ERROR_MESSAGE) if the item on the cursor cannot be equipped. Does nothing if the cursor does not contain an item. +function EquipCursorItem(slot) end \ No newline at end of file diff --git a/api/EquipItemByName.lua b/api/EquipItemByName.lua new file mode 100644 index 0000000..f058da4 --- /dev/null +++ b/api/EquipItemByName.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemID number +---@param itemName string +---@param itemLink string +---Attempts to equip an arbitrary item. The item is automatically equipped in the first available slot in which it fits. To equip an item in a specific slot, see EquipCursorItem(). Causes an error message (UI_ERROR_MESSAGE) if the specified item cannot be equipped. Does nothing if the specified item does not exist or is not in the player's possession. +function EquipItemByName(itemID, itemName, itemLink) end \ No newline at end of file diff --git a/api/EquipPendingItem.lua b/api/EquipPendingItem.lua new file mode 100644 index 0000000..3e1ad41 --- /dev/null +++ b/api/EquipPendingItem.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Confirms equipping a bind-on-equip item. Usable following the EQUIP_BIND_CONFIRM or AUTOEQUIP_BIND_CONFIRM, which fires when the player attempts to equip a bind-on-equip item +function EquipPendingItem(index) end \ No newline at end of file diff --git a/api/EquipmentManagerClearIgnoredSlotsForSave.lua b/api/EquipmentManagerClearIgnoredSlotsForSave.lua new file mode 100644 index 0000000..fa3874c --- /dev/null +++ b/api/EquipmentManagerClearIgnoredSlotsForSave.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Clears the list of equipment slots to be ignored when saving sets +function EquipmentManagerClearIgnoredSlotsForSave() end \ No newline at end of file diff --git a/api/EquipmentManagerIgnoreSlotForSave.lua b/api/EquipmentManagerIgnoreSlotForSave.lua new file mode 100644 index 0000000..5d8e8d0 --- /dev/null +++ b/api/EquipmentManagerIgnoreSlotForSave.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---Adds an equipment slot to the list of those ignored when saving sets. Creating or saving a set with SaveEquipmentSet() will ignore any slots on the list, allowing the player to create sets which only switch certain items (e.g. to equip a fishing pole and hat while leaving non-fishing-related items equipped). +function EquipmentManagerIgnoreSlotForSave(slot) end \ No newline at end of file diff --git a/api/EquipmentManagerIsSlotIgnoredForSave.lua b/api/EquipmentManagerIsSlotIgnoredForSave.lua new file mode 100644 index 0000000..e7ce7dc --- /dev/null +++ b/api/EquipmentManagerIsSlotIgnoredForSave.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return boolean isIgnored +---Returns whether the contents of an equipment slot will be included when saving sets +function EquipmentManagerIsSlotIgnoredForSave(slot) end \ No newline at end of file diff --git a/api/EquipmentManagerUnignoreSlotForSave.lua b/api/EquipmentManagerUnignoreSlotForSave.lua new file mode 100644 index 0000000..7af1d56 --- /dev/null +++ b/api/EquipmentManagerUnignoreSlotForSave.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---Removes an equipment slot from the list of those ignored when saving sets. Creating or saving a set with SaveEquipmentSet() will ignore any slots on the list, allowing the player to create sets which only switch certain items (e.g. to equip a fishing pole and hat while leaving non-fishing-related items equipped). +function EquipmentManagerUnignoreSlotForSave(slot) end \ No newline at end of file diff --git a/api/EquipmentManager_UnpackLocation.lua b/api/EquipmentManager_UnpackLocation.lua new file mode 100644 index 0000000..6780ad5 --- /dev/null +++ b/api/EquipmentManager_UnpackLocation.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param location number +---@return boolean player +---@return boolean bank +---@return boolean bags +---@return number location or slot +---@return number bag +---Unpacks an inventory location bitfield into usable components +function EquipmentManager_UnpackLocation(location) end \ No newline at end of file diff --git a/api/EquipmentSetContainsLockedItems.lua b/api/EquipmentSetContainsLockedItems.lua new file mode 100644 index 0000000..b3cfafb --- /dev/null +++ b/api/EquipmentSetContainsLockedItems.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@return boolean isLocked +---Returns whether an equipment set contains locked items. Locked items are those in a transient state -- e.g. on the cursor for moving within the player's bags, placed in the Send Mail or Trade UIs, etc. -- for which the default UI displays the item's icon as grayed out. A set cannot be equipped if it contains locked items. +function EquipmentSetContainsLockedItems(name) end \ No newline at end of file diff --git a/api/ExecuteVoidTransfer.lua b/api/ExecuteVoidTransfer.lua new file mode 100644 index 0000000..e6a3c9f --- /dev/null +++ b/api/ExecuteVoidTransfer.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ExecuteVoidTransfer() end \ No newline at end of file diff --git a/api/ExpandAllFactionHeaders.lua b/api/ExpandAllFactionHeaders.lua new file mode 100644 index 0000000..e0aa34f --- /dev/null +++ b/api/ExpandAllFactionHeaders.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Expands all headers and sub-headers in the Reputation UI. Expands headers for both major groups (Classic, Burning Crusade, Wrath of the Lich King, Inactive, etc.) and the sub-groups within them (Alliance Forces, Steamwheedle Cartel, Horde Expedition, Shattrath City, etc.). +function ExpandAllFactionHeaders() end \ No newline at end of file diff --git a/api/ExpandChannelHeader.lua b/api/ExpandChannelHeader.lua new file mode 100644 index 0000000..0b9679f --- /dev/null +++ b/api/ExpandChannelHeader.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Expands a group header in the chat channel listing +function ExpandChannelHeader(index) end \ No newline at end of file diff --git a/api/ExpandCurrencyList.lua b/api/ExpandCurrencyList.lua new file mode 100644 index 0000000..6b82a64 --- /dev/null +++ b/api/ExpandCurrencyList.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param shouldExpand number +---Expands or collapses a list header in the Currency UI +function ExpandCurrencyList(index, shouldExpand) end \ No newline at end of file diff --git a/api/ExpandFactionHeader.lua b/api/ExpandFactionHeader.lua new file mode 100644 index 0000000..2bdec34 --- /dev/null +++ b/api/ExpandFactionHeader.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Expands a given faction header or sub-header in the Reputation UI. Faction headers include both major groups (Classic, Burning Crusade, Wrath of the Lich King, Inactive, etc.) and the sub-groups within them (Alliance Forces, Steamwheedle Cartel, Horde Expedition, Shattrath City, etc.). +function ExpandFactionHeader(index) end \ No newline at end of file diff --git a/api/ExpandGuildTradeSkillHeader.lua b/api/ExpandGuildTradeSkillHeader.lua new file mode 100644 index 0000000..e8af6f8 --- /dev/null +++ b/api/ExpandGuildTradeSkillHeader.lua @@ -0,0 +1,16 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param professionID 773 +---@param 164 +---@param 165 +---@param 171 +---@param 182 +---@param 186 +---@param 197 +---@param 202 +---@param 333 +---@param 393 +---@param 755 +---@param 773 +---Expands the corresponding profession in the guild window. This function is used to expand a single profession in the guild window (professions view) based on its ID. Can also be done while window is not visible. See CollapseGuildTradeSkillHeader() for closing the view again. +function ExpandGuildTradeSkillHeader(professionID, 164, 165, 171, 182, 186, 197, 202, 333, 393, 755, 773) end \ No newline at end of file diff --git a/api/ExpandQuestHeader.lua b/api/ExpandQuestHeader.lua new file mode 100644 index 0000000..53acc3a --- /dev/null +++ b/api/ExpandQuestHeader.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param questIndex number +---Expands a quest header in the quest log +function ExpandQuestHeader(questIndex) end \ No newline at end of file diff --git a/api/ExpandTradeSkillSubClass.lua b/api/ExpandTradeSkillSubClass.lua new file mode 100644 index 0000000..02de1ec --- /dev/null +++ b/api/ExpandTradeSkillSubClass.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Expands a group header in the trade skill listing. Causes an error if index does not refer to a header. +function ExpandTradeSkillSubClass(index) end \ No newline at end of file diff --git a/api/ExpandWarGameHeader.lua b/api/ExpandWarGameHeader.lua new file mode 100644 index 0000000..968a63b --- /dev/null +++ b/api/ExpandWarGameHeader.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ExpandWarGameHeader() end \ No newline at end of file diff --git a/api/FactionToggleAtWar.lua b/api/FactionToggleAtWar.lua new file mode 100644 index 0000000..d736df0 --- /dev/null +++ b/api/FactionToggleAtWar.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Toggles "at war" status for a faction. "At War" status determines whether members of a faction can be attacked. Normal interactions (as with merchants, questgivers, etc.) are not available if the player is "at war" with an NPC's faction. This function does nothing for faction headers or factions for which changing "at war" status is not currently allowed; i.e., factions for which the eighth (canToggleAtWar) return of GetFactionInfo is false or nil. +function FactionToggleAtWar(index) end \ No newline at end of file diff --git a/api/FillLocalizedClassList.lua b/api/FillLocalizedClassList.lua new file mode 100644 index 0000000..c9b2393 --- /dev/null +++ b/api/FillLocalizedClassList.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param table number +---@param female boolean +---Fills a table with localized class names keyed by non-localized class tokens. Note that while localized class names have no gender in English, other locales have different names for each gender. +function FillLocalizedClassList(table, female) end \ No newline at end of file diff --git a/api/FindSpellBookSlotBySpellID.lua b/api/FindSpellBookSlotBySpellID.lua new file mode 100644 index 0000000..0b8207d --- /dev/null +++ b/api/FindSpellBookSlotBySpellID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function FindSpellBookSlotBySpellID() end \ No newline at end of file diff --git a/api/FlagTutorial.lua b/api/FlagTutorial.lua new file mode 100644 index 0000000..e6f9a07 --- /dev/null +++ b/api/FlagTutorial.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param tutorial string +---Marks a contextual tutorial as displayed so it doesn't appear again +function FlagTutorial(tutorial) end \ No newline at end of file diff --git a/api/FlipCameraYaw.lua b/api/FlipCameraYaw.lua new file mode 100644 index 0000000..d8ee627 --- /dev/null +++ b/api/FlipCameraYaw.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param degrees number +---Rotates the camera around the player +function FlipCameraYaw(degrees) end \ No newline at end of file diff --git a/api/FlyoutHasSpell.lua b/api/FlyoutHasSpell.lua new file mode 100644 index 0000000..30df816 --- /dev/null +++ b/api/FlyoutHasSpell.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function FlyoutHasSpell() end \ No newline at end of file diff --git a/api/FocusUnit.lua b/api/FocusUnit.lua new file mode 100644 index 0000000..167afe7 --- /dev/null +++ b/api/FocusUnit.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---Changes the focus unitID to refer to a new unit +function FocusUnit(unit, name) end \ No newline at end of file diff --git a/api/FollowUnit.lua b/api/FollowUnit.lua new file mode 100644 index 0000000..f8a56c1 --- /dev/null +++ b/api/FollowUnit.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@param strict boolean +---Causes the player character to automatically follow another unit. Only friendly player units can be followed. +function FollowUnit(unit, name, strict) end \ No newline at end of file diff --git a/api/ForceGossip.lua b/api/ForceGossip.lua new file mode 100644 index 0000000..65a5e9d --- /dev/null +++ b/api/ForceGossip.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ForceGossip() end \ No newline at end of file diff --git a/api/ForceLogout.lua b/api/ForceLogout.lua new file mode 100644 index 0000000..301b6b3 --- /dev/null +++ b/api/ForceLogout.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Forces the client to logout. Not usable in the current WoW client; causes an error message to be displayed. +function ForceLogout() end \ No newline at end of file diff --git a/api/ForceQuit.lua b/api/ForceQuit.lua new file mode 100644 index 0000000..a0813d4 --- /dev/null +++ b/api/ForceQuit.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Immediately exits World of Warcraft. Unlike Quit(), this function exits the game application regardless of current conditions. Used in the default UI when the player chooses "Exit now" in the dialog that appears if the player attempts to quit while not in an inn, major city, or other "rest" area. +function ForceQuit() end \ No newline at end of file diff --git a/api/FrameXML_Debug.lua b/api/FrameXML_Debug.lua new file mode 100644 index 0000000..8fb9d16 --- /dev/null +++ b/api/FrameXML_Debug.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param enable boolean +---Enables or disables logging of XML loading. When logging is enabled, status and error text will be saved to the file Logs/FrameXML.log (path is relative to the folder containing the World of Warcraft client) as the client parses and loads XML files in the default UI and addons. +function FrameXML_Debug(enable) end \ No newline at end of file diff --git a/api/GMEuropaBugsEnabled.lua b/api/GMEuropaBugsEnabled.lua new file mode 100644 index 0000000..4c30c6e --- /dev/null +++ b/api/GMEuropaBugsEnabled.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GMEuropaBugsEnabled() end \ No newline at end of file diff --git a/api/GMEuropaComplaintsEnabled.lua b/api/GMEuropaComplaintsEnabled.lua new file mode 100644 index 0000000..0b1063f --- /dev/null +++ b/api/GMEuropaComplaintsEnabled.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GMEuropaComplaintsEnabled() end \ No newline at end of file diff --git a/api/GMEuropaSuggestionsEnabled.lua b/api/GMEuropaSuggestionsEnabled.lua new file mode 100644 index 0000000..a04ed95 --- /dev/null +++ b/api/GMEuropaSuggestionsEnabled.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GMEuropaSuggestionsEnabled() end \ No newline at end of file diff --git a/api/GMEuropaTicketsEnabled.lua b/api/GMEuropaTicketsEnabled.lua new file mode 100644 index 0000000..5ed8de0 --- /dev/null +++ b/api/GMEuropaTicketsEnabled.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GMEuropaTicketsEnabled() end \ No newline at end of file diff --git a/api/GMItemRestorationButtonEnabled.lua b/api/GMItemRestorationButtonEnabled.lua new file mode 100644 index 0000000..9dd6eff --- /dev/null +++ b/api/GMItemRestorationButtonEnabled.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GMItemRestorationButtonEnabled() end \ No newline at end of file diff --git a/api/GMQuickTicketSystemEnabled.lua b/api/GMQuickTicketSystemEnabled.lua new file mode 100644 index 0000000..2e812e4 --- /dev/null +++ b/api/GMQuickTicketSystemEnabled.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GMQuickTicketSystemEnabled() end \ No newline at end of file diff --git a/api/GMQuickTicketSystemThrottled.lua b/api/GMQuickTicketSystemThrottled.lua new file mode 100644 index 0000000..246aada --- /dev/null +++ b/api/GMQuickTicketSystemThrottled.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GMQuickTicketSystemThrottled() end \ No newline at end of file diff --git a/api/GMReportLag.lua b/api/GMReportLag.lua new file mode 100644 index 0000000..29d8929 --- /dev/null +++ b/api/GMReportLag.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GMReportLag() end \ No newline at end of file diff --git a/api/GMRequestPlayerInfo.lua b/api/GMRequestPlayerInfo.lua new file mode 100644 index 0000000..2f837ca --- /dev/null +++ b/api/GMRequestPlayerInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GMRequestPlayerInfo() end \ No newline at end of file diff --git a/api/GMResponseNeedMoreHelp.lua b/api/GMResponseNeedMoreHelp.lua new file mode 100644 index 0000000..4e6dea8 --- /dev/null +++ b/api/GMResponseNeedMoreHelp.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Requests further GM interaction on a ticket to which a GM has already responded +function GMResponseNeedMoreHelp() end \ No newline at end of file diff --git a/api/GMResponseResolve.lua b/api/GMResponseResolve.lua new file mode 100644 index 0000000..e257651 --- /dev/null +++ b/api/GMResponseResolve.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Notifies the server that the player's GM ticket issue has been resolved +function GMResponseResolve() end \ No newline at end of file diff --git a/api/GMSubmitBug.lua b/api/GMSubmitBug.lua new file mode 100644 index 0000000..d2ccdb3 --- /dev/null +++ b/api/GMSubmitBug.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GMSubmitBug() end \ No newline at end of file diff --git a/api/GMSubmitSuggestion.lua b/api/GMSubmitSuggestion.lua new file mode 100644 index 0000000..8b449d6 --- /dev/null +++ b/api/GMSubmitSuggestion.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GMSubmitSuggestion() end \ No newline at end of file diff --git a/api/GMSurveyAnswer.lua b/api/GMSurveyAnswer.lua new file mode 100644 index 0000000..381deb2 --- /dev/null +++ b/api/GMSurveyAnswer.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param questionIndex number +---@param answerIndex number +---@return string answerText +---Returns text of multiple-choice question answers in a GM survey +function GMSurveyAnswer(questionIndex, answerIndex) end \ No newline at end of file diff --git a/api/GMSurveyAnswerSubmit.lua b/api/GMSurveyAnswerSubmit.lua new file mode 100644 index 0000000..ec54368 --- /dev/null +++ b/api/GMSurveyAnswerSubmit.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param question number +---@param rank number +---@param comment string +---Submits an answer to a GM survey question +function GMSurveyAnswerSubmit(question, rank, comment) end \ No newline at end of file diff --git a/api/GMSurveyCommentSubmit.lua b/api/GMSurveyCommentSubmit.lua new file mode 100644 index 0000000..f5d476c --- /dev/null +++ b/api/GMSurveyCommentSubmit.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param comment string +---Submits a comment to the current GM survey +function GMSurveyCommentSubmit(comment) end \ No newline at end of file diff --git a/api/GMSurveyNumAnswers.lua b/api/GMSurveyNumAnswers.lua new file mode 100644 index 0000000..7f62726 --- /dev/null +++ b/api/GMSurveyNumAnswers.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param questionIndex number +---@return number numAnswers +---Returns the number of possible answers for a GM Survey question. Deprecated; default UI uses the constant MAX_SURVEY_ANSWERS instead. +function GMSurveyNumAnswers(questionIndex) end \ No newline at end of file diff --git a/api/GMSurveyQuestion.lua b/api/GMSurveyQuestion.lua new file mode 100644 index 0000000..6f5dc3d --- /dev/null +++ b/api/GMSurveyQuestion.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string surveyQuestion +---Returns the text of a specific question from a GM survey +function GMSurveyQuestion(index) end \ No newline at end of file diff --git a/api/GMSurveySubmit.lua b/api/GMSurveySubmit.lua new file mode 100644 index 0000000..ee2ca30 --- /dev/null +++ b/api/GMSurveySubmit.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Submits the current GM survey +function GMSurveySubmit() end \ No newline at end of file diff --git a/api/GameMovieFinished.lua b/api/GameMovieFinished.lua new file mode 100644 index 0000000..5b46a04 --- /dev/null +++ b/api/GameMovieFinished.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends in-game movie playback +function GameMovieFinished() end \ No newline at end of file diff --git a/api/GetAbandonQuestItems.lua b/api/GetAbandonQuestItems.lua new file mode 100644 index 0000000..d19fea6 --- /dev/null +++ b/api/GetAbandonQuestItems.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string items +---Returns information about items that would be destroyed by abandoning a quest. Usable after calling SetAbandonQuest() but before calling AbandonQuest(). +function GetAbandonQuestItems() end \ No newline at end of file diff --git a/api/GetAbandonQuestName.lua b/api/GetAbandonQuestName.lua new file mode 100644 index 0000000..8937820 --- /dev/null +++ b/api/GetAbandonQuestName.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string name +---Returns the name of the quest being abandoned. Usable after calling SetAbandonQuest() but before calling AbandonQuest(). +function GetAbandonQuestName() end \ No newline at end of file diff --git a/api/GetAccountExpansionLevel.lua b/api/GetAccountExpansionLevel.lua new file mode 100644 index 0000000..428295b --- /dev/null +++ b/api/GetAccountExpansionLevel.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 5 expansionLevel +---@return 0 +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---@return 5 +---Returns the most recent of WoW's retail expansion packs for which the player's account is authorized. Returns the expansionID of the highest WoW expansion pack the player's account is authorized for. If you intend to find the highest level the player can reach, you should instead use GetExpansionLevel(). +function GetAccountExpansionLevel() end \ No newline at end of file diff --git a/api/GetAchievementCategory.lua b/api/GetAchievementCategory.lua new file mode 100644 index 0000000..ad051d7 --- /dev/null +++ b/api/GetAchievementCategory.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param achievementID number +---@return number categoryID +---Returns the numeric ID of the category to which an achievement belongs +function GetAchievementCategory(achievementID) end \ No newline at end of file diff --git a/api/GetAchievementComparisonInfo.lua b/api/GetAchievementComparisonInfo.lua new file mode 100644 index 0000000..7d49894 --- /dev/null +++ b/api/GetAchievementComparisonInfo.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@return boolean completed +---@return number month +---@return number day +---@return number year +---Returns information about the comparison unit's achievements. Only accurate once the INSPECT_ACHIEVEMENT_READY event has fired following a call to SetAchievementComparisonUnit(). No longer accurate once ClearAchievementComparisonUnit() is called. +function GetAchievementComparisonInfo(id) end \ No newline at end of file diff --git a/api/GetAchievementCriteriaInfo.lua b/api/GetAchievementCriteriaInfo.lua new file mode 100644 index 0000000..a611b67 --- /dev/null +++ b/api/GetAchievementCriteriaInfo.lua @@ -0,0 +1,19 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param achievementID number +---@param index number +---@param statisticID number +---@return string description +---@return number type +---@return boolean completed +---@return number quantity +---@return number requiredQuantity +---@return string characterName +---@return 0x00000002 flags +---@return 0x00000001 +---@return 0x00000002 +---@return number assetID +---@return string quantityString +---@return number criteriaID +---Gets information about criteria for an achievement or data for a statistic +function GetAchievementCriteriaInfo(achievementID, index, statisticID) end \ No newline at end of file diff --git a/api/GetAchievementCriteriaInfoByID.lua b/api/GetAchievementCriteriaInfoByID.lua new file mode 100644 index 0000000..75d400d --- /dev/null +++ b/api/GetAchievementCriteriaInfoByID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetAchievementCriteriaInfoByID() end \ No newline at end of file diff --git a/api/GetAchievementGuildRep.lua b/api/GetAchievementGuildRep.lua new file mode 100644 index 0000000..72cd3b8 --- /dev/null +++ b/api/GetAchievementGuildRep.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetAchievementGuildRep() end \ No newline at end of file diff --git a/api/GetAchievementInfo.lua b/api/GetAchievementInfo.lua new file mode 100644 index 0000000..fa3137c --- /dev/null +++ b/api/GetAchievementInfo.lua @@ -0,0 +1,24 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param category number +---@param index number +---@param id number +---@return number id +---@return string name +---@return number points +---@return boolean completed +---@return number month +---@return number day +---@return number year +---@return string description +---@return 0x00000080 flags +---@return 0x00000001 +---@return 0x00000002 +---@return 0x00000080 +---@return string icon +---@return string rewardText +---@return boolean isGuildAch +---@return boolean wasEarnedByMe +---@return string earnedBy +---Gets information about an achievement or statistic +function GetAchievementInfo(category, index, id) end \ No newline at end of file diff --git a/api/GetAchievementLink.lua b/api/GetAchievementLink.lua new file mode 100644 index 0000000..d2d863e --- /dev/null +++ b/api/GetAchievementLink.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@return string link +---Returns a hyperlink representing the player's progress on an achievement. The tooltip associated with the hyperlink shows not only the details of the achievement itself, but also the completion of or progress towards the achievement by the player who produced the link. +function GetAchievementLink(id) end \ No newline at end of file diff --git a/api/GetAchievementNumCriteria.lua b/api/GetAchievementNumCriteria.lua new file mode 100644 index 0000000..48e4178 --- /dev/null +++ b/api/GetAchievementNumCriteria.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@return number count +---Returns the number of measured criteria for an achievement. Measured criteria for an achievement are shown in the default UI as details when clicking on an achievement in the achievements window or when showing an achievement in the objectives tracker; e.g. "Master of Arms" (15 criteria: Axes, Bows, Crossbows, Daggers, etc.) and "Safe Deposit" (1 criterion: number of bank slots purchased). Not all achievements have criteria: achievements with zero criteria are those that can be completed in a single event (though a complicated event it may be), explained in achievement's description: e.g. "Reach level 80", "Fall 65 yards without dying", and "With all three Twilight Drakes still alive, engage and defeat Sartharion the Onyx Guardian on Normal Difficulty". +function GetAchievementNumCriteria(id) end \ No newline at end of file diff --git a/api/GetAchievementNumRewards.lua b/api/GetAchievementNumRewards.lua new file mode 100644 index 0000000..4487104 --- /dev/null +++ b/api/GetAchievementNumRewards.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@return number count +---Returns the number of point rewards for an achievement (currently always 1). Currently all achievements and statistics offer one reward (according to this function), though the rewards offered by statistics are all zero points. +function GetAchievementNumRewards(id) end \ No newline at end of file diff --git a/api/GetAchievementReward.lua b/api/GetAchievementReward.lua new file mode 100644 index 0000000..cecfb75 --- /dev/null +++ b/api/GetAchievementReward.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@param index number +---@return number points +---Returns the number of achievement points awarded for earning an achievement. Currently all achievements and statistics offer one reward (according to this function), though the rewards offered by statistics are all zero points. +function GetAchievementReward(id, index) end \ No newline at end of file diff --git a/api/GetActionAutocast.lua b/api/GetActionAutocast.lua new file mode 100644 index 0000000..2e93c46 --- /dev/null +++ b/api/GetActionAutocast.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return 1nil autocastAllowed +---@return 1nil autocastEnabled +---Returns information about autocast actions. No player actions have allowed automatic casting since the initial public release of World of Warcraft. +function GetActionAutocast(slot) end \ No newline at end of file diff --git a/api/GetActionBarPage.lua b/api/GetActionBarPage.lua new file mode 100644 index 0000000..1ec9269 --- /dev/null +++ b/api/GetActionBarPage.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number page +---Returns the current action bar page +function GetActionBarPage() end \ No newline at end of file diff --git a/api/GetActionBarToggles.lua b/api/GetActionBarToggles.lua new file mode 100644 index 0000000..d8a5e84 --- /dev/null +++ b/api/GetActionBarToggles.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil showBar1 +---@return 1nil showBar2 +---@return 1nil showBar3 +---@return 1nil showBar4 +---Returns the current visibility settings for the four secondary action bars +function GetActionBarToggles() end \ No newline at end of file diff --git a/api/GetActionCharges.lua b/api/GetActionCharges.lua new file mode 100644 index 0000000..5c50124 --- /dev/null +++ b/api/GetActionCharges.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetActionCharges() end \ No newline at end of file diff --git a/api/GetActionCooldown.lua b/api/GetActionCooldown.lua new file mode 100644 index 0000000..d810276 --- /dev/null +++ b/api/GetActionCooldown.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return number start +---@return number duration +---@return number enable +---Returns cooldown information about an action +function GetActionCooldown(slot) end \ No newline at end of file diff --git a/api/GetActionCount.lua b/api/GetActionCount.lua new file mode 100644 index 0000000..ca8a610 --- /dev/null +++ b/api/GetActionCount.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return number count +---Returns the number of uses remaining for the given action slot. Applies to spells that require reagents, items that stack, or items with charges; used in the default UI to display the count on action buttons. Returns 0 for any action that does not use a count. To distinguish between actions which do not use a count and actions which do but whose current count is 0, see IsConsumableAction. +function GetActionCount(slot) end \ No newline at end of file diff --git a/api/GetActionInfo.lua b/api/GetActionInfo.lua new file mode 100644 index 0000000..8f8db89 --- /dev/null +++ b/api/GetActionInfo.lua @@ -0,0 +1,23 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return spell type +---@return companion +---@return equipmentset +---@return flyout +---@return item +---@return macro +---@return spell +---@return spell id +---@return companion +---@return equipmentset +---@return item +---@return macro +---@return spell +---@return id subType +---@return id CRITTER +---@return id MOUNT +---@return id spell +---@return string spellID +---Returns information about an action slot +function GetActionInfo(slot) end \ No newline at end of file diff --git a/api/GetActionLossOfControlCooldown.lua b/api/GetActionLossOfControlCooldown.lua new file mode 100644 index 0000000..04e8cf3 --- /dev/null +++ b/api/GetActionLossOfControlCooldown.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetActionLossOfControlCooldown() end \ No newline at end of file diff --git a/api/GetActionText.lua b/api/GetActionText.lua new file mode 100644 index 0000000..3299ba5 --- /dev/null +++ b/api/GetActionText.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return string text +---Returns the text label associated with an action. Currently used only for macros, which in the default UI show their name as a label on an action button. +function GetActionText(slot) end \ No newline at end of file diff --git a/api/GetActionTexture.lua b/api/GetActionTexture.lua new file mode 100644 index 0000000..ad39ed3 --- /dev/null +++ b/api/GetActionTexture.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return string texture +---Returns the icon texture for an action. Can be the icon of a spell or item, the icon manually set for a macro, or an icon reflecting the current state of a macro. +function GetActionTexture(slot) end \ No newline at end of file diff --git a/api/GetActiveArtifactByRace.lua b/api/GetActiveArtifactByRace.lua new file mode 100644 index 0000000..b156baf --- /dev/null +++ b/api/GetActiveArtifactByRace.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetActiveArtifactByRace() end \ No newline at end of file diff --git a/api/GetActiveLevel.lua b/api/GetActiveLevel.lua new file mode 100644 index 0000000..664f06d --- /dev/null +++ b/api/GetActiveLevel.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number level +---Returns the level of a quest which can be turned in to the current Quest NPC. Only returns valid information after a QUEST_GREETING event. Note: Most quest NPCs present active quests using the GetGossipActiveQuests() instead of this function. +function GetActiveLevel(index) end \ No newline at end of file diff --git a/api/GetActiveLootRollIDs.lua b/api/GetActiveLootRollIDs.lua new file mode 100644 index 0000000..f821c7b --- /dev/null +++ b/api/GetActiveLootRollIDs.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetActiveLootRollIDs() end \ No newline at end of file diff --git a/api/GetActiveSpecGroup.lua b/api/GetActiveSpecGroup.lua new file mode 100644 index 0000000..82feab1 --- /dev/null +++ b/api/GetActiveSpecGroup.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number activeTalentGroup +---Returns the active talent group/specialisation (Dual Talent system). +function GetActiveSpecGroup() end \ No newline at end of file diff --git a/api/GetActiveTitle.lua b/api/GetActiveTitle.lua new file mode 100644 index 0000000..e43adaf --- /dev/null +++ b/api/GetActiveTitle.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string title +---Returns the name of a quest which can be turned in to the current Quest NPC. Only returns valid information after a QUEST_GREETING event. Note: Most quest NPCs present active quests using the GetGossipActiveQuests() instead of this function. +function GetActiveTitle(index) end \ No newline at end of file diff --git a/api/GetActiveVoiceChannel.lua b/api/GetActiveVoiceChannel.lua new file mode 100644 index 0000000..3625f71 --- /dev/null +++ b/api/GetActiveVoiceChannel.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number index +---Returns the currently active voice channel +function GetActiveVoiceChannel() end \ No newline at end of file diff --git a/api/GetAddOnCPUUsage.lua b/api/GetAddOnCPUUsage.lua new file mode 100644 index 0000000..4f4fe4f --- /dev/null +++ b/api/GetAddOnCPUUsage.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param index number +---@return number usage +---Returns the amount of CPU time used by an addon. Only returns valid data if the scriptProfile CVar is set to 1; returns 0 otherwise. The value returned is from a cache only updated when calling UpdateAddOnCPUUsage(). This value is the sum of GetFunctionCPUUsage() for all functions created on the addon's behalf -- note that if the addon calls external functions which in turn create new functions, the new functions are considered to belong to the addon. +function GetAddOnCPUUsage(name, index) end \ No newline at end of file diff --git a/api/GetAddOnDependencies.lua b/api/GetAddOnDependencies.lua new file mode 100644 index 0000000..2bf2809 --- /dev/null +++ b/api/GetAddOnDependencies.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param index number +---@return list ... +---Returns a list of addons a given addon is dependent upon +function GetAddOnDependencies(name, index) end \ No newline at end of file diff --git a/api/GetAddOnEnableState.lua b/api/GetAddOnEnableState.lua new file mode 100644 index 0000000..0177e0f --- /dev/null +++ b/api/GetAddOnEnableState.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param character string +---@param index number +---@return number enabled +---Queries whether an addon is currently enabled. This may differ from what addons are currently loaded, especially if changes have been made and the UI has not yet been reloaded. +function GetAddOnEnableState(character, index) end \ No newline at end of file diff --git a/api/GetAddOnInfo.lua b/api/GetAddOnInfo.lua new file mode 100644 index 0000000..3c9dc1a --- /dev/null +++ b/api/GetAddOnInfo.lua @@ -0,0 +1,28 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param index number +---@return string name +---@return string title +---@return string notes +---@return 1nil loadable +---@return NOT_DEMAND_LOADED reason +---@return BANNED +---@return CORRUPT +---@return DEP_BANNED +---@return DEP_CORRUPT +---@return DEP_DISABLED +---@return DEP_INCOMPATIBLE +---@return DEP_INSECURE +---@return DEP_INTERFACE_VERSION +---@return DEP_MISSING +---@return DEP_NOT_DEMAND_LOADED +---@return DISABLED +---@return INCOMPATIBLE +---@return INSECURE +---@return INTERFACE_VERSION +---@return MISSING +---@return NOT_DEMAND_LOADED +---@return string security +---Returns information about an addon +function GetAddOnInfo(name, index) end \ No newline at end of file diff --git a/api/GetAddOnMemoryUsage.lua b/api/GetAddOnMemoryUsage.lua new file mode 100644 index 0000000..43c47e9 --- /dev/null +++ b/api/GetAddOnMemoryUsage.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param index number +---@return number mem +---Returns the amount of memory used by an addon. The value returned is from a cache only updated when calling UpdateAddOnMemoryUsage(). +function GetAddOnMemoryUsage(name, index) end \ No newline at end of file diff --git a/api/GetAddOnMetadata.lua b/api/GetAddOnMetadata.lua new file mode 100644 index 0000000..4e7fffd --- /dev/null +++ b/api/GetAddOnMetadata.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param name string +---@param variable string +---@return string data +---Returns the value of certain fields in an addon's TOC file +function GetAddOnMetadata(index, name, variable) end \ No newline at end of file diff --git a/api/GetAddOnOptionalDependencies.lua b/api/GetAddOnOptionalDependencies.lua new file mode 100644 index 0000000..a8006c2 --- /dev/null +++ b/api/GetAddOnOptionalDependencies.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param index number +---@return list ... +---Returns a list of addons a given addon is optionally dependent upon +function GetAddOnOptionalDependencies(name, index) end \ No newline at end of file diff --git a/api/GetAllowLowLevelRaid.lua b/api/GetAllowLowLevelRaid.lua new file mode 100644 index 0000000..9c85028 --- /dev/null +++ b/api/GetAllowLowLevelRaid.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetAllowLowLevelRaid() end \ No newline at end of file diff --git a/api/GetArchaeologyInfo.lua b/api/GetArchaeologyInfo.lua new file mode 100644 index 0000000..aa74336 --- /dev/null +++ b/api/GetArchaeologyInfo.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string name +---Returns information about Archeology +function GetArchaeologyInfo() end \ No newline at end of file diff --git a/api/GetArchaeologyRaceInfo.lua b/api/GetArchaeologyRaceInfo.lua new file mode 100644 index 0000000..ff7540b --- /dev/null +++ b/api/GetArchaeologyRaceInfo.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param raceIndex number +---@return string raceName +---@return string raceTexture +---@return number raceItemID +---@return number numFragmentsCollected +---@return number numFragmentsRequired +---@return number maxFragments +---Get name, icon, index, and fragment for a race. See GetNumArcheologyRaces() for the raceIndex numbers. +function GetArchaeologyRaceInfo(raceIndex) end \ No newline at end of file diff --git a/api/GetArchaeologyRaceInfoByID.lua b/api/GetArchaeologyRaceInfoByID.lua new file mode 100644 index 0000000..cc1d2a2 --- /dev/null +++ b/api/GetArchaeologyRaceInfoByID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetArchaeologyRaceInfoByID() end \ No newline at end of file diff --git a/api/GetAreaMapInfo.lua b/api/GetAreaMapInfo.lua new file mode 100644 index 0000000..2b48527 --- /dev/null +++ b/api/GetAreaMapInfo.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param areaMapID number +---Get information about map zone based on mapId +function GetAreaMapInfo(areaMapID) end \ No newline at end of file diff --git a/api/GetAreaMaps.lua b/api/GetAreaMaps.lua new file mode 100644 index 0000000..8c5d86d --- /dev/null +++ b/api/GetAreaMaps.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param table table +---@return list zoneid1,zoneid2,zoneid3... +---Returns all the IDs of zones available ingame.. When iterating through ALL the zones in the game, you should go over these, instead of something like "for i=1,2000 do ..." +function GetAreaMaps(table) end \ No newline at end of file diff --git a/api/GetAreaSpiritHealerTime.lua b/api/GetAreaSpiritHealerTime.lua new file mode 100644 index 0000000..960debf --- /dev/null +++ b/api/GetAreaSpiritHealerTime.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number timeleft +---Returns the time remaining until a nearby battleground spirit healer resurrects all players in its area +function GetAreaSpiritHealerTime() end \ No newline at end of file diff --git a/api/GetArenaOpponentSpec.lua b/api/GetArenaOpponentSpec.lua new file mode 100644 index 0000000..e517c9d --- /dev/null +++ b/api/GetArenaOpponentSpec.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param oppNumber number +---@return number specialisationID +---Returns information about current enemy specialization. +function GetArenaOpponentSpec(oppNumber) end \ No newline at end of file diff --git a/api/GetArmorEffectiveness.lua b/api/GetArmorEffectiveness.lua new file mode 100644 index 0000000..1fa5f85 --- /dev/null +++ b/api/GetArmorEffectiveness.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetArmorEffectiveness() end \ No newline at end of file diff --git a/api/GetArmorPenetration.lua b/api/GetArmorPenetration.lua new file mode 100644 index 0000000..7c4f200 --- /dev/null +++ b/api/GetArmorPenetration.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number amount +---Returns the percentage of enemy armor ignored due to the player's Armor Penetration Rating +function GetArmorPenetration() end \ No newline at end of file diff --git a/api/GetArtifactInfoByRace.lua b/api/GetArtifactInfoByRace.lua new file mode 100644 index 0000000..3d7f8a0 --- /dev/null +++ b/api/GetArtifactInfoByRace.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetArtifactInfoByRace() end \ No newline at end of file diff --git a/api/GetArtifactProgress.lua b/api/GetArtifactProgress.lua new file mode 100644 index 0000000..282709f --- /dev/null +++ b/api/GetArtifactProgress.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number base +---@return number adjusted +---@return number total_cost +---Returns information about the progress of the currently-selected artifact's construction. +function GetArtifactProgress() end \ No newline at end of file diff --git a/api/GetAttackPowerForStat.lua b/api/GetAttackPowerForStat.lua new file mode 100644 index 0000000..23870db --- /dev/null +++ b/api/GetAttackPowerForStat.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param statIndex 5 +---@param 1 +---@param 2 +---@param 3 +---@param 4 +---@param 5 +---@param effectiveStat number +---@return number attackPower +---Returns the attack power bonus provided by one of the player's basic statistics +function GetAttackPowerForStat(statIndex, 1, 2, 3, 4, 5, effectiveStat) end \ No newline at end of file diff --git a/api/GetAuctionHouseDepositRate.lua b/api/GetAuctionHouseDepositRate.lua new file mode 100644 index 0000000..5947b44 --- /dev/null +++ b/api/GetAuctionHouseDepositRate.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number rate +---Returns the deposit rate for the current auction house. Obsolete (returns different values for faction and neutral auction houses, but these values do not describe the ratio of auction deposit to an item's vendor buy or sell price); use CalculateAuctionDeposit() instead. +function GetAuctionHouseDepositRate() end \ No newline at end of file diff --git a/api/GetAuctionInvTypes.lua b/api/GetAuctionInvTypes.lua new file mode 100644 index 0000000..84da268 --- /dev/null +++ b/api/GetAuctionInvTypes.lua @@ -0,0 +1,14 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param classIndex number +---@param subClassIndex 5 +---@param 1 +---@param 2 +---@param 3 +---@param 4 +---@param 5 +---@return string token +---@return 1nil display +---@return list ... +---Returns a list of the inventory subtypes for a given auction house item subclass. Inventory types are the second level of hierarchy seen when browsing item classes (categories) and subclasses at the Auction House: Head, Neck, Shirt, et al for Miscellaneous; Head, Shoulder, Chest, Wrist, et al for Cloth; etc. This function still returns valid information if the player is not interacting with an auctioneer. +function GetAuctionInvTypes(classIndex, subClassIndex, 1, 2, 3, 4, 5) end \ No newline at end of file diff --git a/api/GetAuctionItemBattlePetInfo.lua b/api/GetAuctionItemBattlePetInfo.lua new file mode 100644 index 0000000..280adfc --- /dev/null +++ b/api/GetAuctionItemBattlePetInfo.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param list owner +---@param bidder +---@param list +---@param owner +---@param index Number +---@return Number creatureID +---@return Number displayID +---Retrieves info about one Battle Pet in the current retrieved list of Battle Pets from the Auction House.. The displayID return appears to always be 0, possibly because the function is only used by Blizzard in conjunction with DressUpBattlePet. +function GetAuctionItemBattlePetInfo(list, bidder, list, owner, index) end \ No newline at end of file diff --git a/api/GetAuctionItemClasses.lua b/api/GetAuctionItemClasses.lua new file mode 100644 index 0000000..5338429 --- /dev/null +++ b/api/GetAuctionItemClasses.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return list ... +---Returns a list of localized item class (category) names. Item classes are the first level of hierarchy seen when browsing at the Auction House: Weapon, Armor, Container, Consumable, etc. This function still returns valid information if the player is not interacting with an auctioneer. +function GetAuctionItemClasses() end \ No newline at end of file diff --git a/api/GetAuctionItemInfo.lua b/api/GetAuctionItemInfo.lua new file mode 100644 index 0000000..27a493f --- /dev/null +++ b/api/GetAuctionItemInfo.lua @@ -0,0 +1,22 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param list owner +---@param bidder +---@param list +---@param owner +---@param index number +---@return string name +---@return string texture +---@return number count +---@return number quality +---@return 1nil canUse +---@return number level +---@return number minBid +---@return number minIncrement +---@return number buyoutPrice +---@return number bidAmount +---@return 1nil highestBidder +---@return string owner +---@return number sold +---Returns information about an auction listing +function GetAuctionItemInfo(list, bidder, list, owner, index) end \ No newline at end of file diff --git a/api/GetAuctionItemLink.lua b/api/GetAuctionItemLink.lua new file mode 100644 index 0000000..4a4316b --- /dev/null +++ b/api/GetAuctionItemLink.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param list owner +---@param bidder +---@param list +---@param owner +---@param index number +---@return string link +---Returns a hyperlink for an item in an auction listing +function GetAuctionItemLink(list, bidder, list, owner, index) end \ No newline at end of file diff --git a/api/GetAuctionItemSubClasses.lua b/api/GetAuctionItemSubClasses.lua new file mode 100644 index 0000000..59868a6 --- /dev/null +++ b/api/GetAuctionItemSubClasses.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param classIndex number +---@return list ... +---Returns a list of localized subclass names for a given item class. Item subclasses are the second level of hierarchy seen when browsing item classes (categories) at the Auction House: One-Handed Axes, Two-Handed Axes, Bows, Guns, et al for Weapon; Cloth, Leather, Plate, Shields, et al for Armor; Food & Drink, Potion, Elixir et al for Consumable; Red, Blue, Yellow, et al for Gem; etc. This function still returns valid information if the player is not interacting with an auctioneer. +function GetAuctionItemSubClasses(classIndex) end \ No newline at end of file diff --git a/api/GetAuctionItemTimeLeft.lua b/api/GetAuctionItemTimeLeft.lua new file mode 100644 index 0000000..fbf009a --- /dev/null +++ b/api/GetAuctionItemTimeLeft.lua @@ -0,0 +1,14 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param list owner +---@param bidder +---@param list +---@param owner +---@param index number +---@return 4 duration +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---Returns the time remaining before an auction listing expires +function GetAuctionItemTimeLeft(list, bidder, list, owner, index) end \ No newline at end of file diff --git a/api/GetAuctionSellItemInfo.lua b/api/GetAuctionSellItemInfo.lua new file mode 100644 index 0000000..c936b3b --- /dev/null +++ b/api/GetAuctionSellItemInfo.lua @@ -0,0 +1,13 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string name +---@return string texture +---@return number count +---@return number quality +---@return 1nil canUse +---@return number pricePerStack +---@return number pricePerItem +---@return number maxStack +---@return number invCount +---Returns information about the item currently being set up for auction. Only returns useful information once an item has been placed in the Create Auction UI's "auction item" slot (see ClickAuctionSellItemButton()). +function GetAuctionSellItemInfo() end \ No newline at end of file diff --git a/api/GetAuctionSort.lua b/api/GetAuctionSort.lua new file mode 100644 index 0000000..d6a083e --- /dev/null +++ b/api/GetAuctionSort.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param list owner +---@param bidder +---@param list +---@param owner +---@param index number +---@return string criterion +---@return 1nil reverse +---Returns the current sort settings for auction data. The index argument describes priority order for sort criteria: e.g. if GetAuctionSort("list",1) returns quality and GetAuctionSort("list",2) returns level,1, items are sorted first by itemQuality and items with the same quality are sorted by required level. +function GetAuctionSort(list, bidder, list, owner, index) end \ No newline at end of file diff --git a/api/GetAutoCompletePresenceID.lua b/api/GetAutoCompletePresenceID.lua new file mode 100644 index 0000000..ea2fd03 --- /dev/null +++ b/api/GetAutoCompletePresenceID.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@return number presenceID +---Obtains the presence ID using a full name or BattleTag. +function GetAutoCompletePresenceID(name) end \ No newline at end of file diff --git a/api/GetAutoCompleteRealms.lua b/api/GetAutoCompleteRealms.lua new file mode 100644 index 0000000..9480b7e --- /dev/null +++ b/api/GetAutoCompleteRealms.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetAutoCompleteRealms() end \ No newline at end of file diff --git a/api/GetAutoCompleteResults.lua b/api/GetAutoCompleteResults.lua new file mode 100644 index 0000000..27b4d29 --- /dev/null +++ b/api/GetAutoCompleteResults.lua @@ -0,0 +1,24 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param inputString string +---@param includeBitfield AUTOCOMPLETE_FLAG_ALL +---@param 0x00000000 AUTOCOMPLETE_FLAG_NONE +---@param 0x00000001 AUTOCOMPLETE_FLAG_IN_GROUP +---@param 0x00000002 AUTOCOMPLETE_FLAG_IN_GUILD +---@param 0x00000004 AUTOCOMPLETE_FLAG_FRIEND +---@param 0x00000010 AUTOCOMPLETE_FLAG_INTERACTED_WITH +---@param 0x00000020 AUTOCOMPLETE_FLAG_ONLINE +---@param 0xffffffff AUTOCOMPLETE_FLAG_ALL +---@param excludeBitfield AUTOCOMPLETE_FLAG_ALL +---@param 0x00000000 AUTOCOMPLETE_FLAG_NONE +---@param 0x00000001 AUTOCOMPLETE_FLAG_IN_GROUP +---@param 0x00000002 AUTOCOMPLETE_FLAG_IN_GUILD +---@param 0x00000004 AUTOCOMPLETE_FLAG_FRIEND +---@param 0x00000010 AUTOCOMPLETE_FLAG_INTERACTED_WITH +---@param 0x00000020 AUTOCOMPLETE_FLAG_ONLINE +---@param 0xffffffff AUTOCOMPLETE_FLAG_ALL +---@param maxResults number +---@param cursorPosition number +---@return list ... +---Returns a list of character names which complete a given partial name prefix +function GetAutoCompleteResults(inputString, includeBitfield, 0x00000000, 0x00000001, 0x00000002, 0x00000004, 0x00000010, 0x00000020, 0xffffffff, excludeBitfield, 0x00000000, 0x00000001, 0x00000002, 0x00000004, 0x00000010, 0x00000020, 0xffffffff, maxResults, cursorPosition) end \ No newline at end of file diff --git a/api/GetAutoDeclineGuildInvites.lua b/api/GetAutoDeclineGuildInvites.lua new file mode 100644 index 0000000..a9cb8de --- /dev/null +++ b/api/GetAutoDeclineGuildInvites.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetAutoDeclineGuildInvites() end \ No newline at end of file diff --git a/api/GetAutoQuestPopUp.lua b/api/GetAutoQuestPopUp.lua new file mode 100644 index 0000000..91e2fe2 --- /dev/null +++ b/api/GetAutoQuestPopUp.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number questId +---@return OFFER type +---@return COMPLETE +---@return OFFER +---Returns information about the AutoQuestPopup(s) +function GetAutoQuestPopUp(index) end \ No newline at end of file diff --git a/api/GetAvailableLevel.lua b/api/GetAvailableLevel.lua new file mode 100644 index 0000000..1d89eaf --- /dev/null +++ b/api/GetAvailableLevel.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number level +---Returns the level of a quest available from the current Quest NPC. Only returns valid information after a QUEST_GREETING event. Note: Most quest NPCs present available quests using the GetGossipAvailableQuests() instead of this function. +function GetAvailableLevel(index) end \ No newline at end of file diff --git a/api/GetAvailableLocales.lua b/api/GetAvailableLocales.lua new file mode 100644 index 0000000..0416478 --- /dev/null +++ b/api/GetAvailableLocales.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetAvailableLocales() end \ No newline at end of file diff --git a/api/GetAvailableQuestInfo.lua b/api/GetAvailableQuestInfo.lua new file mode 100644 index 0000000..142455e --- /dev/null +++ b/api/GetAvailableQuestInfo.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param availableIndex number +---@return boolean isTrivial +---@return LE_QUEST_FREQUENCY_WEEKLY frequency +---@return 1 +---@return LE_QUEST_FREQUENCY_DAILY +---@return LE_QUEST_FREQUENCY_WEEKLY +---@return boolean isRepeatable +---@return boolean isLegendary +---Returns the flags of an available quest during an NPC dialog +function GetAvailableQuestInfo(availableIndex) end \ No newline at end of file diff --git a/api/GetAvailableTitle.lua b/api/GetAvailableTitle.lua new file mode 100644 index 0000000..f1443cf --- /dev/null +++ b/api/GetAvailableTitle.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string title +---Returns the name of a quest available from the current Quest NPC. Only returns valid information after a QUEST_GREETING event. Note: Most quest NPCs present available quests using the GetGossipAvailableQuests() instead of this function. +function GetAvailableTitle(index) end \ No newline at end of file diff --git a/api/GetAverageItemLevel.lua b/api/GetAverageItemLevel.lua new file mode 100644 index 0000000..87c9722 --- /dev/null +++ b/api/GetAverageItemLevel.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number total +---@return number equipped +---@return number pvp +---Returns the players average item level as displayed in the character pane. +function GetAverageItemLevel() end \ No newline at end of file diff --git a/api/GetAvoidance.lua b/api/GetAvoidance.lua new file mode 100644 index 0000000..5aad61b --- /dev/null +++ b/api/GetAvoidance.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetAvoidance() end \ No newline at end of file diff --git a/api/GetBackpackAutosortDisabled.lua b/api/GetBackpackAutosortDisabled.lua new file mode 100644 index 0000000..6dbfba2 --- /dev/null +++ b/api/GetBackpackAutosortDisabled.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetBackpackAutosortDisabled() end \ No newline at end of file diff --git a/api/GetBackpackCurrencyInfo.lua b/api/GetBackpackCurrencyInfo.lua new file mode 100644 index 0000000..210194a --- /dev/null +++ b/api/GetBackpackCurrencyInfo.lua @@ -0,0 +1,13 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---@return number count +---@return 2 extraCurrencyType +---@return 0 +---@return 1 +---@return 2 +---@return string icon +---@return number itemID +---Returns information about a currency marked for watching on the Backpack UI +function GetBackpackCurrencyInfo(index) end \ No newline at end of file diff --git a/api/GetBagName.lua b/api/GetBagName.lua new file mode 100644 index 0000000..3d72027 --- /dev/null +++ b/api/GetBagName.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param container number +---@return string name +---Returns the name of one of the player's bags. Returns nil for the bank and keyring, for bank bags while the player is not at the bank, and for empty bag or bank bag slots. +function GetBagName(container) end \ No newline at end of file diff --git a/api/GetBagSlotFlag.lua b/api/GetBagSlotFlag.lua new file mode 100644 index 0000000..24d3884 --- /dev/null +++ b/api/GetBagSlotFlag.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetBagSlotFlag() end \ No newline at end of file diff --git a/api/GetBankAutosortDisabled.lua b/api/GetBankAutosortDisabled.lua new file mode 100644 index 0000000..dcafa07 --- /dev/null +++ b/api/GetBankAutosortDisabled.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetBankAutosortDisabled() end \ No newline at end of file diff --git a/api/GetBankBagSlotFlag.lua b/api/GetBankBagSlotFlag.lua new file mode 100644 index 0000000..20c176a --- /dev/null +++ b/api/GetBankBagSlotFlag.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetBankBagSlotFlag() end \ No newline at end of file diff --git a/api/GetBankSlotCost.lua b/api/GetBankSlotCost.lua new file mode 100644 index 0000000..e97996c --- /dev/null +++ b/api/GetBankSlotCost.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number cost +---Returns the cost of the next purchasable bank bag slot. Returns 999999999 if the player owns all available slots. +function GetBankSlotCost() end \ No newline at end of file diff --git a/api/GetBarberShopStyleInfo.lua b/api/GetBarberShopStyleInfo.lua new file mode 100644 index 0000000..a7ff7a2 --- /dev/null +++ b/api/GetBarberShopStyleInfo.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param styleIndex 3 +---@param 1 +---@param 2 +---@param 3 +---@return string name +---@return string unused +---@return number cost +---@return 1nil isCurrent +---Returns information about the selected barber shop style option +function GetBarberShopStyleInfo(styleIndex, 1, 2, 3) end \ No newline at end of file diff --git a/api/GetBarberShopTotalCost.lua b/api/GetBarberShopTotalCost.lua new file mode 100644 index 0000000..2bf898f --- /dev/null +++ b/api/GetBarberShopTotalCost.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number cost +---Returns the total price of selected barber shop style changes +function GetBarberShopTotalCost() end \ No newline at end of file diff --git a/api/GetBattlefieldArenaFaction.lua b/api/GetBattlefieldArenaFaction.lua new file mode 100644 index 0000000..09d8f67 --- /dev/null +++ b/api/GetBattlefieldArenaFaction.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Returns faction. Returns faction in and out of battlegrounds +function GetBattlefieldArenaFaction() end \ No newline at end of file diff --git a/api/GetBattlefieldEstimatedWaitTime.lua b/api/GetBattlefieldEstimatedWaitTime.lua new file mode 100644 index 0000000..b8f26a3 --- /dev/null +++ b/api/GetBattlefieldEstimatedWaitTime.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number waitTime +---Returns the estimated wait time on a battleground or arena queue +function GetBattlefieldEstimatedWaitTime(index) end \ No newline at end of file diff --git a/api/GetBattlefieldFlagPosition.lua b/api/GetBattlefieldFlagPosition.lua new file mode 100644 index 0000000..1cf2cd5 --- /dev/null +++ b/api/GetBattlefieldFlagPosition.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number flagX +---@return number flagY +---@return string flagToken +---Returns the position of a flag in a battleground +function GetBattlefieldFlagPosition(index) end \ No newline at end of file diff --git a/api/GetBattlefieldInstanceExpiration.lua b/api/GetBattlefieldInstanceExpiration.lua new file mode 100644 index 0000000..a7210e9 --- /dev/null +++ b/api/GetBattlefieldInstanceExpiration.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number timeLeft +---Returns the amount of time remaining before all players are removed from the instance, if in a battleground instance where the match has completed +function GetBattlefieldInstanceExpiration() end \ No newline at end of file diff --git a/api/GetBattlefieldInstanceRunTime.lua b/api/GetBattlefieldInstanceRunTime.lua new file mode 100644 index 0000000..50d53c6 --- /dev/null +++ b/api/GetBattlefieldInstanceRunTime.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number time +---Returns the amount of time since the current battleground instance opened +function GetBattlefieldInstanceRunTime() end \ No newline at end of file diff --git a/api/GetBattlefieldMapIconScale.lua b/api/GetBattlefieldMapIconScale.lua new file mode 100644 index 0000000..57ca757 --- /dev/null +++ b/api/GetBattlefieldMapIconScale.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number scale +---Returns the scale to be used for displaying battleground map icons. Used in the default UI to determine the size of the point of interest icons (towers, graveyards, etc.) on the zone map (the small battle minimap). The default size of the icons is set by DEFAULT_POI_ICON_SIZE and the scale is used to grow or shrink them depending on the size of the map. +function GetBattlefieldMapIconScale() end \ No newline at end of file diff --git a/api/GetBattlefieldPortExpiration.lua b/api/GetBattlefieldPortExpiration.lua new file mode 100644 index 0000000..5f92d7e --- /dev/null +++ b/api/GetBattlefieldPortExpiration.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number expiration +---Returns the time left on a battleground or arena invitation +function GetBattlefieldPortExpiration(index) end \ No newline at end of file diff --git a/api/GetBattlefieldScore.lua b/api/GetBattlefieldScore.lua new file mode 100644 index 0000000..86a88d9 --- /dev/null +++ b/api/GetBattlefieldScore.lua @@ -0,0 +1,23 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---@return number killingBlows +---@return number honorableKills +---@return number deaths +---@return number honorGained +---@return 1 faction +---@return 0 +---@return 1 +---@return string race +---@return string class +---@return string classToken +---@return number damageDone +---@return number healingDone +---@return number bgRating +---@return number ratingChange +---@return number preMatchMMR +---@return number mmrChange +---@return string talentSpec +---Returns basic scoreboard information for a battleground/arena participant. Does not include battleground-specific score data (e.g. flags captured in Warsong Gulch, towers assaulted in Alterac Valley, etc); see GetBattlefieldStatData() for such information. +function GetBattlefieldScore(index) end \ No newline at end of file diff --git a/api/GetBattlefieldStatData.lua b/api/GetBattlefieldStatData.lua new file mode 100644 index 0000000..69b1f42 --- /dev/null +++ b/api/GetBattlefieldStatData.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param statIndex number +---@return number columnData +---Returns battleground-specific scoreboard information for a battleground participant. Battleground-specific statistics include flags captured in Warsong Gulch, towers assaulted in Alterac Valley, etc. For the name and icon associated with each statistic, see GetBattlefieldStatInfo(). For basic battleground score information, see GetBattlefieldScore(). +function GetBattlefieldStatData(index, statIndex) end \ No newline at end of file diff --git a/api/GetBattlefieldStatInfo.lua b/api/GetBattlefieldStatInfo.lua new file mode 100644 index 0000000..aadc27b --- /dev/null +++ b/api/GetBattlefieldStatInfo.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param statIndex number +---@return string text +---@return string icon +---@return string tooltip +---Returns information about a battleground-specific scoreboard column. Battleground-specific statistics include flags captured in Warsong Gulch, towers assaulted in Alterac Valley, etc. +function GetBattlefieldStatInfo(statIndex) end \ No newline at end of file diff --git a/api/GetBattlefieldStatus.lua b/api/GetBattlefieldStatus.lua new file mode 100644 index 0000000..bbf024f --- /dev/null +++ b/api/GetBattlefieldStatus.lua @@ -0,0 +1,20 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return queued status +---@return active +---@return confirm +---@return none +---@return queued +---@return string mapName +---@return number instanceID +---@return number bracketMin +---@return number bracketMax +---@return 5 teamSize +---@return 0 +---@return 2 +---@return 3 +---@return 5 +---@return 1nil registeredMatch +---Returns information about an active or queued battleground/arena instance +function GetBattlefieldStatus(index) end \ No newline at end of file diff --git a/api/GetBattlefieldTeamInfo.lua b/api/GetBattlefieldTeamInfo.lua new file mode 100644 index 0000000..c2ed4be --- /dev/null +++ b/api/GetBattlefieldTeamInfo.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index 1 +---@param 0 +---@param 1 +---@return string teamName +---@return number teamRating +---@return number newTeamRating +---@return number teamMMR +---@return number numPlayers +---Returns info about teams and their rating and MMR in a rated arena match. Usable following the UPDATE_BATTLEFIELD_SCORE event. +function GetBattlefieldTeamInfo(index, 0, 1) end \ No newline at end of file diff --git a/api/GetBattlefieldTimeWaited.lua b/api/GetBattlefieldTimeWaited.lua new file mode 100644 index 0000000..88ecb9f --- /dev/null +++ b/api/GetBattlefieldTimeWaited.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number timeInQueue +---Returns the amount of time elapsed since the player joined the queue for a battleground/arena +function GetBattlefieldTimeWaited(index) end \ No newline at end of file diff --git a/api/GetBattlefieldVehicleInfo.lua b/api/GetBattlefieldVehicleInfo.lua new file mode 100644 index 0000000..f8727b0 --- /dev/null +++ b/api/GetBattlefieldVehicleInfo.lua @@ -0,0 +1,19 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number vehicleX +---@return number vehicleY +---@return string unitName +---@return boolean isPossessed +---@return Idle vehicleType +---@return Airship Alliance +---@return Airship Horde +---@return Carriage +---@return Drive +---@return Fly +---@return Idle +---@return number orientation +---@return boolean isPlayer +---@return boolean isAlive +---Returns information about special vehicles in the current zone. Used only for certain vehicles in certain zones: includes the airships in Icecrown as well as vehicles used in Ulduar, Wintergrasp, and Strand of the Ancients. +function GetBattlefieldVehicleInfo(index) end \ No newline at end of file diff --git a/api/GetBattlefieldWinner.lua b/api/GetBattlefieldWinner.lua new file mode 100644 index 0000000..c4927ac --- /dev/null +++ b/api/GetBattlefieldWinner.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 255 winner +---@return 0 +---@return 1 +---@return 255 +---Returns the winner of the current battleground or arena match +function GetBattlefieldWinner() end \ No newline at end of file diff --git a/api/GetBattlegroundInfo.lua b/api/GetBattlegroundInfo.lua new file mode 100644 index 0000000..27b643d --- /dev/null +++ b/api/GetBattlegroundInfo.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string localizedName +---@return 1nil canEnter +---@return 1nil isHoliday +---@return 1nil isRandom +---@return number BattleGroundID +---@return string mapDescription +---Returns information about available battlegrounds +function GetBattlegroundInfo(index) end \ No newline at end of file diff --git a/api/GetBattlegroundPoints.lua b/api/GetBattlegroundPoints.lua new file mode 100644 index 0000000..954e4bc --- /dev/null +++ b/api/GetBattlegroundPoints.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetBattlegroundPoints() end \ No newline at end of file diff --git a/api/GetBestFlexRaidChoice.lua b/api/GetBestFlexRaidChoice.lua new file mode 100644 index 0000000..4205415 --- /dev/null +++ b/api/GetBestFlexRaidChoice.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetBestFlexRaidChoice() end \ No newline at end of file diff --git a/api/GetBestRFChoice.lua b/api/GetBestRFChoice.lua new file mode 100644 index 0000000..dcbf923 --- /dev/null +++ b/api/GetBestRFChoice.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetBestRFChoice() end \ No newline at end of file diff --git a/api/GetBidderAuctionItems.lua b/api/GetBidderAuctionItems.lua new file mode 100644 index 0000000..cee2423 --- /dev/null +++ b/api/GetBidderAuctionItems.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Requests data from the server for the list of auctions bid on by the player. The AUCTION_BIDDER_LIST_UPDATE event fires if new data is available; listing information can then be retrieved using GetAuctionItemInfo() or other Auction APIs. +function GetBidderAuctionItems() end \ No newline at end of file diff --git a/api/GetBillingTimeRested.lua b/api/GetBillingTimeRested.lua new file mode 100644 index 0000000..a4e3791 --- /dev/null +++ b/api/GetBillingTimeRested.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number time +---Returns the amount of time for which the player must be offline in order to lift play time restrictions. After playing for a number of hours, restrictions may be placed on the player's ability to gain loot or XP, complete quests, or use trade skills; if in such a state, the player must log off for the period of time specified by this function in order to return to normal play. Only used in locales where the length of play sessions is restricted (e.g. mainland China). +function GetBillingTimeRested() end \ No newline at end of file diff --git a/api/GetBindLocation.lua b/api/GetBindLocation.lua new file mode 100644 index 0000000..58cbcb7 --- /dev/null +++ b/api/GetBindLocation.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string location +---Returns the name of the player's Hearthstone location +function GetBindLocation() end \ No newline at end of file diff --git a/api/GetBinding.lua b/api/GetBinding.lua new file mode 100644 index 0000000..e5899ed --- /dev/null +++ b/api/GetBinding.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string commandName +---@return string binding1 +---@return string binding2 +---Returns information about a key binding +function GetBinding(index) end \ No newline at end of file diff --git a/api/GetBindingAction.lua b/api/GetBindingAction.lua new file mode 100644 index 0000000..d4e80e5 --- /dev/null +++ b/api/GetBindingAction.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param key string +---@param checkOverride boolean +---@return string action +---Returns the action bound to a key or key combination +function GetBindingAction(key, checkOverride) end \ No newline at end of file diff --git a/api/GetBindingByKey.lua b/api/GetBindingByKey.lua new file mode 100644 index 0000000..e7f4da0 --- /dev/null +++ b/api/GetBindingByKey.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param key string +---@return string action +---Returns the action bound to a key or key combination +function GetBindingByKey(key) end \ No newline at end of file diff --git a/api/GetBindingKey.lua b/api/GetBindingKey.lua new file mode 100644 index 0000000..159dbad --- /dev/null +++ b/api/GetBindingKey.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param COMMAND string +---@return string key1 +---@return list ... +---Returns the key combinations for a given binding command. Although the default UI only allows two combinations to be bound to a command, more than two can be set via the API. +function GetBindingKey(COMMAND) end \ No newline at end of file diff --git a/api/GetBindingText.lua b/api/GetBindingText.lua new file mode 100644 index 0000000..0c975a8 --- /dev/null +++ b/api/GetBindingText.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetBindingText() end \ No newline at end of file diff --git a/api/GetBlacklistMap.lua b/api/GetBlacklistMap.lua new file mode 100644 index 0000000..ecf22a4 --- /dev/null +++ b/api/GetBlacklistMap.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param i number +---@return number bgIndex +---Return ID of blacklisted battleground. +function GetBlacklistMap(i) end \ No newline at end of file diff --git a/api/GetBlacklistMapName.lua b/api/GetBlacklistMapName.lua new file mode 100644 index 0000000..44dd92f --- /dev/null +++ b/api/GetBlacklistMapName.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetBlacklistMapName() end \ No newline at end of file diff --git a/api/GetBladedArmorEffect.lua b/api/GetBladedArmorEffect.lua new file mode 100644 index 0000000..665ca71 --- /dev/null +++ b/api/GetBladedArmorEffect.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetBladedArmorEffect() end \ No newline at end of file diff --git a/api/GetBlockChance.lua b/api/GetBlockChance.lua new file mode 100644 index 0000000..e8da424 --- /dev/null +++ b/api/GetBlockChance.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number chance +---Returns the player's percentage chance to block with a shield +function GetBlockChance() end \ No newline at end of file diff --git a/api/GetBonusBarIndex.lua b/api/GetBonusBarIndex.lua new file mode 100644 index 0000000..8baf626 --- /dev/null +++ b/api/GetBonusBarIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetBonusBarIndex() end \ No newline at end of file diff --git a/api/GetBonusBarOffset.lua b/api/GetBonusBarOffset.lua new file mode 100644 index 0000000..ce681dd --- /dev/null +++ b/api/GetBonusBarOffset.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number offset +---Returns the current "stance" offset for use with the bonus action bar. This value corresponds to what "stance" the player is currently in, and more specifically which set of actions correspond to that stance. Action IDs for special stances start on action bar #7 (or NUM_ACTIONBAR_PAGES + 1), so the offset returned by this function corresponds to the number to be added to NUM_ACTIONBAR_PAGES in calculating action IDs for these action bars. Note that the UI definition of "stance" includes not just warrior stances but also druid shapeshift forms, rogue/druid stealth, priest shadowform, and various other cases, but does not necessarily include all states normally presented in the default UI's stance/shapeshift bar (notable exclusions are paladin auras and death knight presences). +function GetBonusBarOffset() end \ No newline at end of file diff --git a/api/GetBuildInfo.lua b/api/GetBuildInfo.lua new file mode 100644 index 0000000..36c7ef4 --- /dev/null +++ b/api/GetBuildInfo.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string version +---@return string internalVersion +---@return string date +---@return number uiVersion +---Returns the version information about the client +function GetBuildInfo() end \ No newline at end of file diff --git a/api/GetBuybackItemInfo.lua b/api/GetBuybackItemInfo.lua new file mode 100644 index 0000000..c4e9640 --- /dev/null +++ b/api/GetBuybackItemInfo.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---@return string texture +---@return number price +---@return number quantity +---@return number numAvailable +---@return 1nil isUsable +---Returns information about an item recently sold to a vendor and available to be repurchased +function GetBuybackItemInfo(index) end \ No newline at end of file diff --git a/api/GetBuybackItemLink.lua b/api/GetBuybackItemLink.lua new file mode 100644 index 0000000..40d77df --- /dev/null +++ b/api/GetBuybackItemLink.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string link +---Returns a hyperlink for an item recently sold to a vendor and available to be repurchased +function GetBuybackItemLink(index) end \ No newline at end of file diff --git a/api/GetCVar.lua b/api/GetCVar.lua new file mode 100644 index 0000000..8980fed --- /dev/null +++ b/api/GetCVar.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param cvar string +---@return any string +---Returns the value of a configuration variable. Causes an error if the named CVar does not exist. Note that all values are returned as strings: use of tonumber() may be required if using a value in a numeric context. (See also GetCVarBool() for binary values.) +function GetCVar(cvar) end \ No newline at end of file diff --git a/api/GetCVarBitfield.lua b/api/GetCVarBitfield.lua new file mode 100644 index 0000000..b0bf4eb --- /dev/null +++ b/api/GetCVarBitfield.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetCVarBitfield() end \ No newline at end of file diff --git a/api/GetCVarBool.lua b/api/GetCVarBool.lua new file mode 100644 index 0000000..ff08ae7 --- /dev/null +++ b/api/GetCVarBool.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param cvar string +---@return 1nil value +---Returns the value of a configuration variable in a format compatible with Lua conditional expressions. All configuration variables are stored as strings; many CVars represent the state of a binary flag and are stored as either "1" or "0". This function provides a convenient way to test the state of such variables without the extra syntax required to explicitly check for "1" or "0" values. +function GetCVarBool(cvar) end \ No newline at end of file diff --git a/api/GetCVarDefault.lua b/api/GetCVarDefault.lua new file mode 100644 index 0000000..9d23e6d --- /dev/null +++ b/api/GetCVarDefault.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param CVar string +---@return string value +---Returns the default value of a configuration variable. Causes an error if the named CVar does not exist. +function GetCVarDefault(CVar) end \ No newline at end of file diff --git a/api/GetCVarInfo.lua b/api/GetCVarInfo.lua new file mode 100644 index 0000000..19a1e1b --- /dev/null +++ b/api/GetCVarInfo.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param cvar string +---@return string value +---@return string defaultValue +---@return 1nil serverStoredAccountWide +---@return 1nil serverStoredPerCharacter +---Returns information about a configuration variable +function GetCVarInfo(cvar) end \ No newline at end of file diff --git a/api/GetCallPetSpellInfo.lua b/api/GetCallPetSpellInfo.lua new file mode 100644 index 0000000..d69a200 --- /dev/null +++ b/api/GetCallPetSpellInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetCallPetSpellInfo() end \ No newline at end of file diff --git a/api/GetCategoryAchievementPoints.lua b/api/GetCategoryAchievementPoints.lua new file mode 100644 index 0000000..962cc9f --- /dev/null +++ b/api/GetCategoryAchievementPoints.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param categoryID number +---@param includeSubCategories boolean +---@return number total +---Returns the number of achievement points obtained in this category +function GetCategoryAchievementPoints(categoryID, includeSubCategories) end \ No newline at end of file diff --git a/api/GetCategoryInfo.lua b/api/GetCategoryInfo.lua new file mode 100644 index 0000000..1460372 --- /dev/null +++ b/api/GetCategoryInfo.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@return string name +---@return number parentID +---@return bitfield flags +---Returns information about an achievement/statistic category +function GetCategoryInfo(id) end \ No newline at end of file diff --git a/api/GetCategoryList.lua b/api/GetCategoryList.lua new file mode 100644 index 0000000..825b133 --- /dev/null +++ b/api/GetCategoryList.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return table categories +---Returns a list of all achievement categories. See GetGuildCategoryList() for the guild version. +function GetCategoryList() end \ No newline at end of file diff --git a/api/GetCategoryNumAchievements.lua b/api/GetCategoryNumAchievements.lua new file mode 100644 index 0000000..a9b8b75 --- /dev/null +++ b/api/GetCategoryNumAchievements.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@param includeSuperseded boolean +---@return number numItems +---@return number numCompleted +---@return number numUncompleted +---Returns the number of achievements/statistics to display in a category. Without the includeSuperseded parameter this function only returns the number of achievements displayed in the default UI. The includeSuperseded parameter does not influence the number to be displayed in the default UI. Achievements may belong to a category but not be counted for display: e.g. among those which are part of a series (100 Quests Completed, 500 Quests Completed), only the achievement most recently completed and the achievement following it in the series are shown.Note that numUncompleted only includes the visible uncompleted achievements, so in e.g. the series 10 quests -> 25 quests -> 100 quests -> 500 quests, if you've completed 80 quests (so "100 quests" comes next and "500 quests" is hidden), only "100 quests" counts towards numUncompleted.BUG: for includeSuperseded=false the returned numItems is sometimes too high (as is numUncompleted) +function GetCategoryNumAchievements(id, includeSuperseded) end \ No newline at end of file diff --git a/api/GetCemeteryPreference.lua b/api/GetCemeteryPreference.lua new file mode 100644 index 0000000..942019d --- /dev/null +++ b/api/GetCemeteryPreference.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetCemeteryPreference() end \ No newline at end of file diff --git a/api/GetChallengeBestTime.lua b/api/GetChallengeBestTime.lua new file mode 100644 index 0000000..bb73ddb --- /dev/null +++ b/api/GetChallengeBestTime.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetChallengeBestTime() end \ No newline at end of file diff --git a/api/GetChallengeBestTimeInfo.lua b/api/GetChallengeBestTimeInfo.lua new file mode 100644 index 0000000..7e2f7a8 --- /dev/null +++ b/api/GetChallengeBestTimeInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetChallengeBestTimeInfo() end \ No newline at end of file diff --git a/api/GetChallengeBestTimeNum.lua b/api/GetChallengeBestTimeNum.lua new file mode 100644 index 0000000..e956638 --- /dev/null +++ b/api/GetChallengeBestTimeNum.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetChallengeBestTimeNum() end \ No newline at end of file diff --git a/api/GetChallengeMapMoney.lua b/api/GetChallengeMapMoney.lua new file mode 100644 index 0000000..e46ab15 --- /dev/null +++ b/api/GetChallengeMapMoney.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetChallengeMapMoney() end \ No newline at end of file diff --git a/api/GetChallengeMapRewardInfo.lua b/api/GetChallengeMapRewardInfo.lua new file mode 100644 index 0000000..a739a6d --- /dev/null +++ b/api/GetChallengeMapRewardInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetChallengeMapRewardInfo() end \ No newline at end of file diff --git a/api/GetChallengeMode.lua b/api/GetChallengeMode.lua new file mode 100644 index 0000000..6c04a8b --- /dev/null +++ b/api/GetChallengeMode.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetChallengeMode() end \ No newline at end of file diff --git a/api/GetChallengeModeCompletionInfo.lua b/api/GetChallengeModeCompletionInfo.lua new file mode 100644 index 0000000..25ed5b9 --- /dev/null +++ b/api/GetChallengeModeCompletionInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetChallengeModeCompletionInfo() end \ No newline at end of file diff --git a/api/GetChallengeModeCompletionReward.lua b/api/GetChallengeModeCompletionReward.lua new file mode 100644 index 0000000..cdc4020 --- /dev/null +++ b/api/GetChallengeModeCompletionReward.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetChallengeModeCompletionReward() end \ No newline at end of file diff --git a/api/GetChallengeModeLeaderInfo.lua b/api/GetChallengeModeLeaderInfo.lua new file mode 100644 index 0000000..dc72b92 --- /dev/null +++ b/api/GetChallengeModeLeaderInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetChallengeModeLeaderInfo() end \ No newline at end of file diff --git a/api/GetChallengeModeMapInfo.lua b/api/GetChallengeModeMapInfo.lua new file mode 100644 index 0000000..d4eb4f4 --- /dev/null +++ b/api/GetChallengeModeMapInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetChallengeModeMapInfo() end \ No newline at end of file diff --git a/api/GetChallengeModeMapPlayerStats.lua b/api/GetChallengeModeMapPlayerStats.lua new file mode 100644 index 0000000..be36b57 --- /dev/null +++ b/api/GetChallengeModeMapPlayerStats.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetChallengeModeMapPlayerStats() end \ No newline at end of file diff --git a/api/GetChallengeModeMapTable.lua b/api/GetChallengeModeMapTable.lua new file mode 100644 index 0000000..97a5d42 --- /dev/null +++ b/api/GetChallengeModeMapTable.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetChallengeModeMapTable() end \ No newline at end of file diff --git a/api/GetChallengeModeMapTimes.lua b/api/GetChallengeModeMapTimes.lua new file mode 100644 index 0000000..88b2bfc --- /dev/null +++ b/api/GetChallengeModeMapTimes.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetChallengeModeMapTimes() end \ No newline at end of file diff --git a/api/GetChannelDisplayInfo.lua b/api/GetChannelDisplayInfo.lua new file mode 100644 index 0000000..7e4adb0 --- /dev/null +++ b/api/GetChannelDisplayInfo.lua @@ -0,0 +1,17 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---@return 1nil header +---@return 1nil collapsed +---@return number channelNumber +---@return number count +---@return 1nil active +---@return CHANNEL_CATEGORY_WORLD category +---@return CHANNEL_CATEGORY_CUSTOM +---@return CHANNEL_CATEGORY_GROUP +---@return CHANNEL_CATEGORY_WORLD +---@return 1nil voiceEnabled +---@return 1nil voiceActive +---Returns information about an entry in the channel list display +function GetChannelDisplayInfo(index) end \ No newline at end of file diff --git a/api/GetChannelList.lua b/api/GetChannelList.lua new file mode 100644 index 0000000..91f36a6 --- /dev/null +++ b/api/GetChannelList.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number index +---@return string channel +---@return list ... +---Returns the list of the channels the player has joined +function GetChannelList() end \ No newline at end of file diff --git a/api/GetChannelName.lua b/api/GetChannelName.lua new file mode 100644 index 0000000..3411547 --- /dev/null +++ b/api/GetChannelName.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param channelIndex number +---@param channelName string +---@return number channel +---@return string channelName +---@return number instanceID +---Returns information about a chat channel +function GetChannelName(channelIndex, channelName) end \ No newline at end of file diff --git a/api/GetChannelRosterInfo.lua b/api/GetChannelRosterInfo.lua new file mode 100644 index 0000000..b6f8d58 --- /dev/null +++ b/api/GetChannelRosterInfo.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param rosterIndex number +---@return string name +---@return 1nil owner +---@return 1nil moderator +---@return 1nil muted +---@return 1nil active +---@return 1nil enabled +---Returns information about a character in a chat channel in the channel list display +function GetChannelRosterInfo(index, rosterIndex) end \ No newline at end of file diff --git a/api/GetChatTypeIndex.lua b/api/GetChatTypeIndex.lua new file mode 100644 index 0000000..ee2b1aa --- /dev/null +++ b/api/GetChatTypeIndex.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param messageGroup string +---@return number index +---Returns the numeric index corresponding to a chat message type. These indices are used in the default UI to identify lines printed in a chat window, allowing (for example) their color to be changed to match changes in the player's color preferences. +function GetChatTypeIndex(messageGroup) end \ No newline at end of file diff --git a/api/GetChatWindowChannels.lua b/api/GetChatWindowChannels.lua new file mode 100644 index 0000000..34c5956 --- /dev/null +++ b/api/GetChatWindowChannels.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string channelName +---@return number channelId +---@return list ... +---Returns the saved list of channels to which a chat window is subscribed +function GetChatWindowChannels(index) end \ No newline at end of file diff --git a/api/GetChatWindowInfo.lua b/api/GetChatWindowInfo.lua new file mode 100644 index 0000000..a5f8d7a --- /dev/null +++ b/api/GetChatWindowInfo.lua @@ -0,0 +1,15 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---@return number fontSize +---@return number r +---@return number g +---@return number b +---@return number alpha +---@return number shown +---@return number locked +---@return number docked +---@return number uninteractable +---Returns the saved settings for a chat window. These values reflect the settings saved between sessions, which are used by the default UI to set up the chat frames it displays. +function GetChatWindowInfo(index) end \ No newline at end of file diff --git a/api/GetChatWindowMessages.lua b/api/GetChatWindowMessages.lua new file mode 100644 index 0000000..4474067 --- /dev/null +++ b/api/GetChatWindowMessages.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return list ... +---Returns the saved list of messages to which a chat window is subscribed +function GetChatWindowMessages(index) end \ No newline at end of file diff --git a/api/GetChatWindowSavedDimensions.lua b/api/GetChatWindowSavedDimensions.lua new file mode 100644 index 0000000..c18612a --- /dev/null +++ b/api/GetChatWindowSavedDimensions.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetChatWindowSavedDimensions() end \ No newline at end of file diff --git a/api/GetChatWindowSavedPosition.lua b/api/GetChatWindowSavedPosition.lua new file mode 100644 index 0000000..6bdeb28 --- /dev/null +++ b/api/GetChatWindowSavedPosition.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetChatWindowSavedPosition() end \ No newline at end of file diff --git a/api/GetClassInfo.lua b/api/GetClassInfo.lua new file mode 100644 index 0000000..a429496 --- /dev/null +++ b/api/GetClassInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetClassInfo() end \ No newline at end of file diff --git a/api/GetClassInfoByID.lua b/api/GetClassInfoByID.lua new file mode 100644 index 0000000..8128214 --- /dev/null +++ b/api/GetClassInfoByID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetClassInfoByID() end \ No newline at end of file diff --git a/api/GetClickFrame.lua b/api/GetClickFrame.lua new file mode 100644 index 0000000..3b10ae9 --- /dev/null +++ b/api/GetClickFrame.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@return table frame +---Returns the Frame object associated with the given name. Returns nil if there is no UI object with the name given, or if the named UI object is not a Frame. +function GetClickFrame(name) end \ No newline at end of file diff --git a/api/GetCoinIcon.lua b/api/GetCoinIcon.lua new file mode 100644 index 0000000..be8eeb4 --- /dev/null +++ b/api/GetCoinIcon.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param amount number +---@return Interface\Icons\INV_Misc_Coin_06 icon +---@return Interface\Icons\INV_Misc_Coin_01 +---@return Interface\Icons\INV_Misc_Coin_02 +---@return Interface\Icons\INV_Misc_Coin_03 +---@return Interface\Icons\INV_Misc_Coin_04 +---@return Interface\Icons\INV_Misc_Coin_05 +---@return Interface\Icons\INV_Misc_Coin_06 +---Returns an icon representing an amount of money +function GetCoinIcon(amount) end \ No newline at end of file diff --git a/api/GetCoinText.lua b/api/GetCoinText.lua new file mode 100644 index 0000000..565a372 --- /dev/null +++ b/api/GetCoinText.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param amount number +---@param separator string +---@return string coinText +---Returns a localized string describing an amount of money +function GetCoinText(amount, separator) end \ No newline at end of file diff --git a/api/GetCoinTextureString.lua b/api/GetCoinTextureString.lua new file mode 100644 index 0000000..bb23462 --- /dev/null +++ b/api/GetCoinTextureString.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param amount number +---@param fontSize number +---@return string coinText +---Returns a string with embedded coin icons describing an amount of money. As in most places where money amounts are shown in the UI, lesser denominations are only shown when non-zero. +function GetCoinTextureString(amount, fontSize) end \ No newline at end of file diff --git a/api/GetCombatRating.lua b/api/GetCombatRating.lua new file mode 100644 index 0000000..304c489 --- /dev/null +++ b/api/GetCombatRating.lua @@ -0,0 +1,29 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param ratingIndex CR_WEAPON_SKILL_RANGED +---@param CR_BLOCK +---@param CR_CRIT_MELEE +---@param CR_CRIT_RANGED +---@param CR_CRIT_SPELL +---@param CR_CRIT_TAKEN_MELEE +---@param CR_CRIT_TAKEN_RANGED +---@param CR_CRIT_TAKEN_SPELL +---@param CR_DEFENSE_SKILL +---@param CR_DODGE +---@param CR_HASTE_MELEE +---@param CR_HASTE_RANGED +---@param CR_HASTE_SPELL +---@param CR_HIT_MELEE +---@param CR_HIT_RANGED +---@param CR_HIT_SPELL +---@param CR_HIT_TAKEN_MELEE +---@param CR_HIT_TAKEN_RANGED +---@param CR_HIT_TAKEN_SPELL +---@param CR_PARRY +---@param CR_WEAPON_SKILL +---@param CR_WEAPON_SKILL_MAINHAND +---@param CR_WEAPON_SKILL_OFFHAND +---@param CR_WEAPON_SKILL_RANGED +---@return number rating +---Returns the value of a combat rating for the player +function GetCombatRating(ratingIndex, CR_BLOCK, CR_CRIT_MELEE, CR_CRIT_RANGED, CR_CRIT_SPELL, CR_CRIT_TAKEN_MELEE, CR_CRIT_TAKEN_RANGED, CR_CRIT_TAKEN_SPELL, CR_DEFENSE_SKILL, CR_DODGE, CR_HASTE_MELEE, CR_HASTE_RANGED, CR_HASTE_SPELL, CR_HIT_MELEE, CR_HIT_RANGED, CR_HIT_SPELL, CR_HIT_TAKEN_MELEE, CR_HIT_TAKEN_RANGED, CR_HIT_TAKEN_SPELL, CR_PARRY, CR_WEAPON_SKILL, CR_WEAPON_SKILL_MAINHAND, CR_WEAPON_SKILL_OFFHAND, CR_WEAPON_SKILL_RANGED) end \ No newline at end of file diff --git a/api/GetCombatRatingBonus.lua b/api/GetCombatRatingBonus.lua new file mode 100644 index 0000000..532a5f0 --- /dev/null +++ b/api/GetCombatRatingBonus.lua @@ -0,0 +1,29 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param ratingIndex CR_WEAPON_SKILL_RANGED +---@param CR_BLOCK +---@param CR_CRIT_MELEE +---@param CR_CRIT_RANGED +---@param CR_CRIT_SPELL +---@param CR_CRIT_TAKEN_MELEE +---@param CR_CRIT_TAKEN_RANGED +---@param CR_CRIT_TAKEN_SPELL +---@param CR_DEFENSE_SKILL +---@param CR_DODGE +---@param CR_HASTE_MELEE +---@param CR_HASTE_RANGED +---@param CR_HASTE_SPELL +---@param CR_HIT_MELEE +---@param CR_HIT_RANGED +---@param CR_HIT_SPELL +---@param CR_HIT_TAKEN_MELEE +---@param CR_HIT_TAKEN_RANGED +---@param CR_HIT_TAKEN_SPELL +---@param CR_PARRY +---@param CR_WEAPON_SKILL +---@param CR_WEAPON_SKILL_MAINHAND +---@param CR_WEAPON_SKILL_OFFHAND +---@param CR_WEAPON_SKILL_RANGED +---@return number ratingBonus +---Returns the percentage effect for the player's current value of a given combat rating. Used in the default UI to show tooltips with actual percentage effects (such as increased parry chance or reduced critical strike damage taken) when mousing over rating information in the Character window. +function GetCombatRatingBonus(ratingIndex, CR_BLOCK, CR_CRIT_MELEE, CR_CRIT_RANGED, CR_CRIT_SPELL, CR_CRIT_TAKEN_MELEE, CR_CRIT_TAKEN_RANGED, CR_CRIT_TAKEN_SPELL, CR_DEFENSE_SKILL, CR_DODGE, CR_HASTE_MELEE, CR_HASTE_RANGED, CR_HASTE_SPELL, CR_HIT_MELEE, CR_HIT_RANGED, CR_HIT_SPELL, CR_HIT_TAKEN_MELEE, CR_HIT_TAKEN_RANGED, CR_HIT_TAKEN_SPELL, CR_PARRY, CR_WEAPON_SKILL, CR_WEAPON_SKILL_MAINHAND, CR_WEAPON_SKILL_OFFHAND, CR_WEAPON_SKILL_RANGED) end \ No newline at end of file diff --git a/api/GetComboPoints.lua b/api/GetComboPoints.lua new file mode 100644 index 0000000..d663fbf --- /dev/null +++ b/api/GetComboPoints.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param target string +---@return number comboPoints +---Returns the player's number of combo points on the target. +function GetComboPoints(unit, target) end \ No newline at end of file diff --git a/api/GetCompanionInfo.lua b/api/GetCompanionInfo.lua new file mode 100644 index 0000000..51873bc --- /dev/null +++ b/api/GetCompanionInfo.lua @@ -0,0 +1,19 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param type MOUNT +---@param CRITTER +---@param MOUNT +---@param index number +---@return number creatureID +---@return string creatureName +---@return number spellID +---@return string icon +---@return 1nil active +---@return 0x10 mountFlags +---@return 0x01 +---@return 0x02 +---@return 0x04 +---@return 0x08 +---@return 0x10 +---Returns information about a non-combat pet or mount +function GetCompanionInfo(type, CRITTER, MOUNT, index) end \ No newline at end of file diff --git a/api/GetComparisonAchievementPoints.lua b/api/GetComparisonAchievementPoints.lua new file mode 100644 index 0000000..95f22f4 --- /dev/null +++ b/api/GetComparisonAchievementPoints.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number points +---Returns the comparison unit's total achievement points earned.   Only accurate once the INSPECT_ACHIEVEMENT_READY event has fired following a call to SetAchievementComparisonUnit(). No longer accurate once ClearAchievementComparisonUnit() is called. +function GetComparisonAchievementPoints() end \ No newline at end of file diff --git a/api/GetComparisonCategoryNumAchievements.lua b/api/GetComparisonCategoryNumAchievements.lua new file mode 100644 index 0000000..fd84f16 --- /dev/null +++ b/api/GetComparisonCategoryNumAchievements.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@return number numCompleted +---Returns the number of achievements completed by the comparison unit within a category.   Only accurate once the INSPECT_ACHIEVEMENT_READY event has fired following a call to SetAchievementComparisonUnit(). No longer accurate once ClearAchievementComparisonUnit() is called. +function GetComparisonCategoryNumAchievements(id) end \ No newline at end of file diff --git a/api/GetComparisonStatistic.lua b/api/GetComparisonStatistic.lua new file mode 100644 index 0000000..194a5c9 --- /dev/null +++ b/api/GetComparisonStatistic.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@return string info +---Returns the comparison unit's data for a statistic.   Only accurate once the INSPECT_ACHIEVEMENT_READY event has fired following a call to SetAchievementComparisonUnit(). No longer accurate once ClearAchievementComparisonUnit() is called. +function GetComparisonStatistic(id) end \ No newline at end of file diff --git a/api/GetContainerFreeSlots.lua b/api/GetContainerFreeSlots.lua new file mode 100644 index 0000000..ba185b9 --- /dev/null +++ b/api/GetContainerFreeSlots.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param container number +---@param returnTable table +---@return table slotTable +---Returns a list of open slots in a container. The optional argument returnTable allows for performance optimization in cases where this function is expected to be called repeatedly. Rather than creating new tables each time the function is called (eventually requiring garbage collection), an existing table can be recycled. (Note, however, that this function does not clear the table's contents; use wipe() first to guarantee consistent results.) +function GetContainerFreeSlots(container, returnTable) end \ No newline at end of file diff --git a/api/GetContainerItemCooldown.lua b/api/GetContainerItemCooldown.lua new file mode 100644 index 0000000..f6e517c --- /dev/null +++ b/api/GetContainerItemCooldown.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param container number +---@param slot number +---@return number start +---@return number duration +---@return number enable +---Returns cooldown information about an item in the player's bags +function GetContainerItemCooldown(container, slot) end \ No newline at end of file diff --git a/api/GetContainerItemDurability.lua b/api/GetContainerItemDurability.lua new file mode 100644 index 0000000..21ae05c --- /dev/null +++ b/api/GetContainerItemDurability.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param container number +---@param slot number +---@return number durability +---@return number max +---Returns durability status for an item in the player's bags +function GetContainerItemDurability(container, slot) end \ No newline at end of file diff --git a/api/GetContainerItemEquipmentSetInfo.lua b/api/GetContainerItemEquipmentSetInfo.lua new file mode 100644 index 0000000..d3526cc --- /dev/null +++ b/api/GetContainerItemEquipmentSetInfo.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param slot number +---@return boolean isInSet +---@return string setName +---Returns whether an item in the bags is a part of a saved item set. +function GetContainerItemEquipmentSetInfo(index, slot) end \ No newline at end of file diff --git a/api/GetContainerItemGems.lua b/api/GetContainerItemGems.lua new file mode 100644 index 0000000..865e0a3 --- /dev/null +++ b/api/GetContainerItemGems.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param container bagID +---@param slot number +---@return itemID gem1 +---@return itemID gem2 +---@return itemID gem3 +---Returns the gems socketed in an item in the player's bags. The IDs returned refer to the gems themselves (not the enchantments they provide), and thus can be passed to GetItemInfo() to get a gem's name, quality, icon, etc. +function GetContainerItemGems(container, slot) end \ No newline at end of file diff --git a/api/GetContainerItemID.lua b/api/GetContainerItemID.lua new file mode 100644 index 0000000..83a33f8 --- /dev/null +++ b/api/GetContainerItemID.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param container number +---@param slot number +---@return itemID id +---Returns the item ID of an item in the player's bags +function GetContainerItemID(container, slot) end \ No newline at end of file diff --git a/api/GetContainerItemInfo.lua b/api/GetContainerItemInfo.lua new file mode 100644 index 0000000..bd29dd0 --- /dev/null +++ b/api/GetContainerItemInfo.lua @@ -0,0 +1,16 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param container number +---@param slot number +---@return string texture +---@return number count +---@return 1nil locked +---@return number quality +---@return 1nil readable +---@return 1nil lootable +---@return itemLink link +---@return boolean isFiltered +---@return boolean hasNoValue +---@return number itemID +---Returns information about an item in the player's bags +function GetContainerItemInfo(container, slot) end \ No newline at end of file diff --git a/api/GetContainerItemLink.lua b/api/GetContainerItemLink.lua new file mode 100644 index 0000000..e0b6190 --- /dev/null +++ b/api/GetContainerItemLink.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param container number +---@param slot number +---@return string link +---Returns a hyperlink for an item in the player's bags +function GetContainerItemLink(container, slot) end \ No newline at end of file diff --git a/api/GetContainerItemPurchaseCurrency.lua b/api/GetContainerItemPurchaseCurrency.lua new file mode 100644 index 0000000..9873d44 --- /dev/null +++ b/api/GetContainerItemPurchaseCurrency.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetContainerItemPurchaseCurrency() end \ No newline at end of file diff --git a/api/GetContainerItemPurchaseInfo.lua b/api/GetContainerItemPurchaseInfo.lua new file mode 100644 index 0000000..f7fcb9e --- /dev/null +++ b/api/GetContainerItemPurchaseInfo.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param container number +---@param slot number +---@param IsEquipped boolean +---@return number money +---@return number itemCount +---@return number refundSec +---@return number currecycount +---@return number hasEnchants +---Returns information about alternate currencies refunded for returning an item to vendors. Items bought with alternate currency (honor points, arena points, or special items such as Emblems of Heroism and Dalaran Cooking Awards) can be returned to a vendor for a full refund, but only within a limited time after the original purchase. If the given container slot is empty, contains an item which cannot be returned for an alternate currency refund, or contains an item for which the refund grace period has expired, all returns are nil. +function GetContainerItemPurchaseInfo(container, slot, IsEquipped) end \ No newline at end of file diff --git a/api/GetContainerItemPurchaseItem.lua b/api/GetContainerItemPurchaseItem.lua new file mode 100644 index 0000000..a8d85c5 --- /dev/null +++ b/api/GetContainerItemPurchaseItem.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param container number +---@param slot number +---@param index number +---@return string texture +---@return number quantity +---@return itemLink link +---Returns information about a specific currency refunded for returning an item to vendors. See GetContainerItemPurchaseInfo for more information about alternate currency refunds. +function GetContainerItemPurchaseItem(container, slot, index) end \ No newline at end of file diff --git a/api/GetContainerItemQuestInfo.lua b/api/GetContainerItemQuestInfo.lua new file mode 100644 index 0000000..4892eb3 --- /dev/null +++ b/api/GetContainerItemQuestInfo.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param container number +---@param slot number +---@return boolean isQuest +---@return number questId +---@return 1nil isActive +---Returns quest information about an item in the player's bags +function GetContainerItemQuestInfo(container, slot) end \ No newline at end of file diff --git a/api/GetContainerNumFreeSlots.lua b/api/GetContainerNumFreeSlots.lua new file mode 100644 index 0000000..523c867 --- /dev/null +++ b/api/GetContainerNumFreeSlots.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param container number +---@return number freeSlots +---@return number bagType +---Returns the number of free slots in a container and the types of items it can hold +function GetContainerNumFreeSlots(container) end \ No newline at end of file diff --git a/api/GetContainerNumSlots.lua b/api/GetContainerNumSlots.lua new file mode 100644 index 0000000..e14ba79 --- /dev/null +++ b/api/GetContainerNumSlots.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param container number +---@return number numSlots +---Returns the number of slots in one of the player's bags +function GetContainerNumSlots(container) end \ No newline at end of file diff --git a/api/GetContinentMapInfo.lua b/api/GetContinentMapInfo.lua new file mode 100644 index 0000000..5fa1575 --- /dev/null +++ b/api/GetContinentMapInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetContinentMapInfo() end \ No newline at end of file diff --git a/api/GetContinentMaps.lua b/api/GetContinentMaps.lua new file mode 100644 index 0000000..4fdede0 --- /dev/null +++ b/api/GetContinentMaps.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetContinentMaps() end \ No newline at end of file diff --git a/api/GetCorpseMapPosition.lua b/api/GetCorpseMapPosition.lua new file mode 100644 index 0000000..bde8c24 --- /dev/null +++ b/api/GetCorpseMapPosition.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number corpseX +---@return number corpseY +---Returns the position of the player's corpse on the world map. Returns 0,0 if the location of the player's corpse is not visible on the current world map. +function GetCorpseMapPosition() end \ No newline at end of file diff --git a/api/GetCorpseRecoveryDelay.lua b/api/GetCorpseRecoveryDelay.lua new file mode 100644 index 0000000..56f086d --- /dev/null +++ b/api/GetCorpseRecoveryDelay.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number timeLeft +---Returns the amount of time left until the player can recover their corpse. Applies to resurrection spells offered by other units, resurrecting by returning to the player's corpse as a ghost, and to resurrecting at a graveyard's spirit healer, if the player has recently died several times in short succession. +function GetCorpseRecoveryDelay() end \ No newline at end of file diff --git a/api/GetCritChance.lua b/api/GetCritChance.lua new file mode 100644 index 0000000..8744d58 --- /dev/null +++ b/api/GetCritChance.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number critChance +---Returns the player's melee critical strike chance +function GetCritChance() end \ No newline at end of file diff --git a/api/GetCritChanceFromAgility.lua b/api/GetCritChanceFromAgility.lua new file mode 100644 index 0000000..b1caf43 --- /dev/null +++ b/api/GetCritChanceFromAgility.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return number critChance +---Returns additional critical strike chance provided by Agility +function GetCritChanceFromAgility(unit) end \ No newline at end of file diff --git a/api/GetCritChanceProvidesParryEffect.lua b/api/GetCritChanceProvidesParryEffect.lua new file mode 100644 index 0000000..c9b9eba --- /dev/null +++ b/api/GetCritChanceProvidesParryEffect.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetCritChanceProvidesParryEffect() end \ No newline at end of file diff --git a/api/GetCriteriaSpell.lua b/api/GetCriteriaSpell.lua new file mode 100644 index 0000000..d711730 --- /dev/null +++ b/api/GetCriteriaSpell.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetCriteriaSpell() end \ No newline at end of file diff --git a/api/GetCurrencyInfo.lua b/api/GetCurrencyInfo.lua new file mode 100644 index 0000000..dbee27d --- /dev/null +++ b/api/GetCurrencyInfo.lua @@ -0,0 +1,13 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@return string name +---@return number amount +---@return string texturePath +---@return number earnedThisWeek +---@return number weeklyMax +---@return number totalMax +---@return boolean isDiscovered +---@return number quality +---Returns information about a currency by ID +function GetCurrencyInfo(id) end \ No newline at end of file diff --git a/api/GetCurrencyLink.lua b/api/GetCurrencyLink.lua new file mode 100644 index 0000000..1e6ede3 --- /dev/null +++ b/api/GetCurrencyLink.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@return string link +---Returns a hyperlink for the given currency +function GetCurrencyLink(id) end \ No newline at end of file diff --git a/api/GetCurrencyListInfo.lua b/api/GetCurrencyListInfo.lua new file mode 100644 index 0000000..a5db1fb --- /dev/null +++ b/api/GetCurrencyListInfo.lua @@ -0,0 +1,16 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---@return boolean isHeader +---@return boolean isExpanded +---@return boolean isUnused +---@return boolean isWatched +---@return number count +---@return string icon +---@return number maximum +---@return number hasWeeklyLimit +---@return number currentWeeklyAmount +---@return unknown unknown +---Returns information about a currency type (or headers in the Currency UI) +function GetCurrencyListInfo(index) end \ No newline at end of file diff --git a/api/GetCurrencyListLink.lua b/api/GetCurrencyListLink.lua new file mode 100644 index 0000000..c35b96f --- /dev/null +++ b/api/GetCurrencyListLink.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetCurrencyListLink() end \ No newline at end of file diff --git a/api/GetCurrencyListSize.lua b/api/GetCurrencyListSize.lua new file mode 100644 index 0000000..62a530d --- /dev/null +++ b/api/GetCurrencyListSize.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numEntries +---Returns the number of list entries to show in the Currency UI +function GetCurrencyListSize() end \ No newline at end of file diff --git a/api/GetCurrentArenaSeason.lua b/api/GetCurrentArenaSeason.lua new file mode 100644 index 0000000..04318a9 --- /dev/null +++ b/api/GetCurrentArenaSeason.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number season +---Returns a number identifying the current arena season. New arena seasons begin every few months, resetting team rankings and providing new rewards. +function GetCurrentArenaSeason() end \ No newline at end of file diff --git a/api/GetCurrentBindingSet.lua b/api/GetCurrentBindingSet.lua new file mode 100644 index 0000000..08c156c --- /dev/null +++ b/api/GetCurrentBindingSet.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 2 bindingSet +---@return 1 +---@return 2 +---Returns which set of key bindings is currently in use +function GetCurrentBindingSet() end \ No newline at end of file diff --git a/api/GetCurrentGraphicsSetting.lua b/api/GetCurrentGraphicsSetting.lua new file mode 100644 index 0000000..a6e05ec --- /dev/null +++ b/api/GetCurrentGraphicsSetting.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetCurrentGraphicsSetting() end \ No newline at end of file diff --git a/api/GetCurrentGuildBankTab.lua b/api/GetCurrentGuildBankTab.lua new file mode 100644 index 0000000..c130343 --- /dev/null +++ b/api/GetCurrentGuildBankTab.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number index +---Returns the currently selected guild bank tab +function GetCurrentGuildBankTab() end \ No newline at end of file diff --git a/api/GetCurrentKeyBoardFocus.lua b/api/GetCurrentKeyBoardFocus.lua new file mode 100644 index 0000000..96f99b1 --- /dev/null +++ b/api/GetCurrentKeyBoardFocus.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return table frame +---Returns the frame currently handling keyboard input. Typically an EditBox +function GetCurrentKeyBoardFocus() end \ No newline at end of file diff --git a/api/GetCurrentLevelDraenorTalent.lua b/api/GetCurrentLevelDraenorTalent.lua new file mode 100644 index 0000000..1f89d3e --- /dev/null +++ b/api/GetCurrentLevelDraenorTalent.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetCurrentLevelDraenorTalent() end \ No newline at end of file diff --git a/api/GetCurrentLevelSpells.lua b/api/GetCurrentLevelSpells.lua new file mode 100644 index 0000000..82c2718 --- /dev/null +++ b/api/GetCurrentLevelSpells.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetCurrentLevelSpells() end \ No newline at end of file diff --git a/api/GetCurrentMapAreaID.lua b/api/GetCurrentMapAreaID.lua new file mode 100644 index 0000000..3017928 --- /dev/null +++ b/api/GetCurrentMapAreaID.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number areaID +---Returns an ID number for the current map zone. Currently only used in the default UI to determine whether the Wintergrasp map is showing (and if so, display the time remaining until the next battle). +function GetCurrentMapAreaID() end \ No newline at end of file diff --git a/api/GetCurrentMapContinent.lua b/api/GetCurrentMapContinent.lua new file mode 100644 index 0000000..f639d7d --- /dev/null +++ b/api/GetCurrentMapContinent.lua @@ -0,0 +1,14 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 7 continent +---@return -1 +---@return 0 +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---@return 5 +---@return 6 +---@return 7 +---Returns the current world map continent +function GetCurrentMapContinent() end \ No newline at end of file diff --git a/api/GetCurrentMapDungeonLevel.lua b/api/GetCurrentMapDungeonLevel.lua new file mode 100644 index 0000000..106bca5 --- /dev/null +++ b/api/GetCurrentMapDungeonLevel.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number dungeonLevel +---@return number x1 +---@return number y1 +---@return number x2 +---@return number y2 +---Returns which map image is currently selected on the world map (for zones which use more than one map image). Used in zones with more than one "floor" or area, such as Dalaran and several Wrath of the Lich King dungeons and raids. More than one map image may contain the player's current location; if the world map has not been explicitly set to show a particular area, this returns whichever is the "best" match. The coordinates provided are used to place the different dungeon maps relative to each other. +function GetCurrentMapDungeonLevel() end \ No newline at end of file diff --git a/api/GetCurrentMapHeaderIndex.lua b/api/GetCurrentMapHeaderIndex.lua new file mode 100644 index 0000000..d7c473c --- /dev/null +++ b/api/GetCurrentMapHeaderIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetCurrentMapHeaderIndex() end \ No newline at end of file diff --git a/api/GetCurrentMapLevelRange.lua b/api/GetCurrentMapLevelRange.lua new file mode 100644 index 0000000..9f5ddb5 --- /dev/null +++ b/api/GetCurrentMapLevelRange.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number minLevel +---@return number maxLevel +---Returns the level range of the currently shown zone. +function GetCurrentMapLevelRange() end \ No newline at end of file diff --git a/api/GetCurrentMapZone.lua b/api/GetCurrentMapZone.lua new file mode 100644 index 0000000..f953d7c --- /dev/null +++ b/api/GetCurrentMapZone.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number zone +---Returns the current world map zone +function GetCurrentMapZone() end \ No newline at end of file diff --git a/api/GetCurrentResolution.lua b/api/GetCurrentResolution.lua new file mode 100644 index 0000000..2a5e203 --- /dev/null +++ b/api/GetCurrentResolution.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number index +---Returns the index of the current resolution setting. For the dimensions of a resolution setting, use GetScreenResolutions(). +function GetCurrentResolution() end \ No newline at end of file diff --git a/api/GetCurrentTitle.lua b/api/GetCurrentTitle.lua new file mode 100644 index 0000000..885f0c8 --- /dev/null +++ b/api/GetCurrentTitle.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return integer currentTitle +---Returns the currently selected player title +function GetCurrentTitle() end \ No newline at end of file diff --git a/api/GetCursorInfo.lua b/api/GetCursorInfo.lua new file mode 100644 index 0000000..7090ec5 --- /dev/null +++ b/api/GetCursorInfo.lua @@ -0,0 +1,33 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return spell type +---@return battlepet +---@return companion +---@return equipmentset +---@return flyout +---@return guildbankmoney +---@return item +---@return macro +---@return merchant +---@return money +---@return petaction +---@return spell +---@return spellbookID data +---@return battlepet +---@return number companion +---@return string equipmentset +---@return number guildbankmoney +---@return itemID item +---@return macroID macro +---@return number merchant +---@return number money +---@return petaction +---@return spellbookID spell +---@return data subType +---@return data companion +---@return hyperlink item +---@return data spell +---@return spell subData +---@return spell +---Returns information about the contents of the cursor +function GetCursorInfo() end \ No newline at end of file diff --git a/api/GetCursorMoney.lua b/api/GetCursorMoney.lua new file mode 100644 index 0000000..fa8c0a8 --- /dev/null +++ b/api/GetCursorMoney.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number cursorMoney +---Returns the amount of money currently on the cursor +function GetCursorMoney() end \ No newline at end of file diff --git a/api/GetCursorPosition.lua b/api/GetCursorPosition.lua new file mode 100644 index 0000000..c87615e --- /dev/null +++ b/api/GetCursorPosition.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number cursorX +---@return number cursorY +---Returns the absolute position of the mouse cursor +function GetCursorPosition() end \ No newline at end of file diff --git a/api/GetDailyQuestsCompleted.lua b/api/GetDailyQuestsCompleted.lua new file mode 100644 index 0000000..70640b9 --- /dev/null +++ b/api/GetDailyQuestsCompleted.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number dailyQuestsComplete +---Returns the number of daily quests the player has completed today. The daily quest period resets at or around 3:00 AM server time on most realms. +function GetDailyQuestsCompleted() end \ No newline at end of file diff --git a/api/GetDeathReleasePosition.lua b/api/GetDeathReleasePosition.lua new file mode 100644 index 0000000..c4e49b3 --- /dev/null +++ b/api/GetDeathReleasePosition.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number graveyardX +---@return number graveyardY +---Returns the location of the graveyard where the player's spirit will appear upon release. Returns 0,0 if the player is not dead or the graveyard's location is not visible on the current world map. +function GetDeathReleasePosition() end \ No newline at end of file diff --git a/api/GetDebugAnimationStats.lua b/api/GetDebugAnimationStats.lua new file mode 100644 index 0000000..108a2c8 --- /dev/null +++ b/api/GetDebugAnimationStats.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetDebugAnimationStats() end \ No newline at end of file diff --git a/api/GetDebugSpellEffects.lua b/api/GetDebugSpellEffects.lua new file mode 100644 index 0000000..62aa518 --- /dev/null +++ b/api/GetDebugSpellEffects.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetDebugSpellEffects() end \ No newline at end of file diff --git a/api/GetDebugStats.lua b/api/GetDebugStats.lua new file mode 100644 index 0000000..99f90d3 --- /dev/null +++ b/api/GetDebugStats.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetDebugStats() end \ No newline at end of file diff --git a/api/GetDebugZoneMap.lua b/api/GetDebugZoneMap.lua new file mode 100644 index 0000000..6873e92 --- /dev/null +++ b/api/GetDebugZoneMap.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetDebugZoneMap() end \ No newline at end of file diff --git a/api/GetDefaultLanguage.lua b/api/GetDefaultLanguage.lua new file mode 100644 index 0000000..3017d97 --- /dev/null +++ b/api/GetDefaultLanguage.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string language +---Returns the name of the player character's default language. This is the language used in the chat system (Common or Orcish, as opposed to Taurahe, Darnassian, etc), not the real-world language of the client or server. +function GetDefaultLanguage() end \ No newline at end of file diff --git a/api/GetDefaultVideoOptions.lua b/api/GetDefaultVideoOptions.lua new file mode 100644 index 0000000..1ee18a2 --- /dev/null +++ b/api/GetDefaultVideoOptions.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetDefaultVideoOptions() end \ No newline at end of file diff --git a/api/GetDefaultVideoQualityOption.lua b/api/GetDefaultVideoQualityOption.lua new file mode 100644 index 0000000..b1f297e --- /dev/null +++ b/api/GetDefaultVideoQualityOption.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetDefaultVideoQualityOption() end \ No newline at end of file diff --git a/api/GetDistanceSqToQuest.lua b/api/GetDistanceSqToQuest.lua new file mode 100644 index 0000000..6f61251 --- /dev/null +++ b/api/GetDistanceSqToQuest.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number distance +---Returns a (squared) distance to the quest objective location +function GetDistanceSqToQuest(index) end \ No newline at end of file diff --git a/api/GetDodgeChance.lua b/api/GetDodgeChance.lua new file mode 100644 index 0000000..6880cd7 --- /dev/null +++ b/api/GetDodgeChance.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number chance +---Returns the player's chance to dodge melee attacks +function GetDodgeChance() end \ No newline at end of file diff --git a/api/GetDungeonDifficultyID.lua b/api/GetDungeonDifficultyID.lua new file mode 100644 index 0000000..4d125e2 --- /dev/null +++ b/api/GetDungeonDifficultyID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetDungeonDifficultyID() end \ No newline at end of file diff --git a/api/GetDungeonMapInfo.lua b/api/GetDungeonMapInfo.lua new file mode 100644 index 0000000..e2a2c69 --- /dev/null +++ b/api/GetDungeonMapInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetDungeonMapInfo() end \ No newline at end of file diff --git a/api/GetDungeonMaps.lua b/api/GetDungeonMaps.lua new file mode 100644 index 0000000..d5675ae --- /dev/null +++ b/api/GetDungeonMaps.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetDungeonMaps() end \ No newline at end of file diff --git a/api/GetEclipseDirection.lua b/api/GetEclipseDirection.lua new file mode 100644 index 0000000..076eff6 --- /dev/null +++ b/api/GetEclipseDirection.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string direction +---Returns the direction in which the players eclipse is moving. +function GetEclipseDirection() end \ No newline at end of file diff --git a/api/GetEquipmentSetIgnoreSlots.lua b/api/GetEquipmentSetIgnoreSlots.lua new file mode 100644 index 0000000..57bcab3 --- /dev/null +++ b/api/GetEquipmentSetIgnoreSlots.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetEquipmentSetIgnoreSlots() end \ No newline at end of file diff --git a/api/GetEquipmentSetInfo.lua b/api/GetEquipmentSetInfo.lua new file mode 100644 index 0000000..d729cd2 --- /dev/null +++ b/api/GetEquipmentSetInfo.lua @@ -0,0 +1,14 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---@return string icon +---@return number setID +---@return boolean isEquipped +---@return number numItems +---@return number numEquipped +---@return number numInventory +---@return number numMissing +---@return number numIgnored +---Returns information about an equipment set (specified by index) +function GetEquipmentSetInfo(index) end \ No newline at end of file diff --git a/api/GetEquipmentSetInfoByName.lua b/api/GetEquipmentSetInfoByName.lua new file mode 100644 index 0000000..c2b05c1 --- /dev/null +++ b/api/GetEquipmentSetInfoByName.lua @@ -0,0 +1,13 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@return string icon +---@return number setID +---@return boolean isEquipped +---@return number numItems +---@return number numEquipped +---@return number unknown +---@return number numMissing +---@return number numIgnored +---Returns information about an equipment set +function GetEquipmentSetInfoByName(name) end \ No newline at end of file diff --git a/api/GetEquipmentSetItemIDs.lua b/api/GetEquipmentSetItemIDs.lua new file mode 100644 index 0000000..3dab0a2 --- /dev/null +++ b/api/GetEquipmentSetItemIDs.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@return table itemIDs +---Returns a table listing the items in an equipment set +function GetEquipmentSetItemIDs(name) end \ No newline at end of file diff --git a/api/GetEquipmentSetLocations.lua b/api/GetEquipmentSetLocations.lua new file mode 100644 index 0000000..d11e096 --- /dev/null +++ b/api/GetEquipmentSetLocations.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@return table itemIDs +---Returns a table listing the locations of the items in an equipment set +function GetEquipmentSetLocations(name) end \ No newline at end of file diff --git a/api/GetEventCPUUsage.lua b/api/GetEventCPUUsage.lua new file mode 100644 index 0000000..36e0b39 --- /dev/null +++ b/api/GetEventCPUUsage.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param event string +---@return number usage +---@return number numEvents +---Returns information about the CPU usage of an event. Only returns valid data if the scriptProfile CVar is set to 1; returns 0 otherwise. +function GetEventCPUUsage(event) end \ No newline at end of file diff --git a/api/GetEventTime.lua b/api/GetEventTime.lua new file mode 100644 index 0000000..c4f5483 --- /dev/null +++ b/api/GetEventTime.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetEventTime() end \ No newline at end of file diff --git a/api/GetExistingSocketInfo.lua b/api/GetExistingSocketInfo.lua new file mode 100644 index 0000000..5c34fa1 --- /dev/null +++ b/api/GetExistingSocketInfo.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---@return string texture +---@return 1nil name +---Returns information about a permanently socketed gem. If the given socket contains a permanently socketed gem, returns information for that gem (even if a new gem has been dropped in the socket to overwrite the existing gem, but has not yet been confirmed). If the socket is empty, returns nil. Only returns valid information when the Item Socketing UI is open (i.e. between the SOCKET_INFO_UPDATE and SOCKET_INFO_CLOSE events). +function GetExistingSocketInfo(index) end \ No newline at end of file diff --git a/api/GetExistingSocketLink.lua b/api/GetExistingSocketLink.lua new file mode 100644 index 0000000..e2683ad --- /dev/null +++ b/api/GetExistingSocketLink.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string link +---Returns a hyperlink for a permanently socketed gem. If the given socket contains a permanently socketed gem, returns an item link for that gem (even if a new gem has been dropped in the socket to overwrite the existing gem, but has not yet been confirmed). If the socket is empty, returns nil. Only returns valid information when the Item Socketing UI is open (i.e. between the SOCKET_INFO_UPDATE and SOCKET_INFO_CLOSE events). +function GetExistingSocketLink(index) end \ No newline at end of file diff --git a/api/GetExpansionLevel.lua b/api/GetExpansionLevel.lua new file mode 100644 index 0000000..05bce87 --- /dev/null +++ b/api/GetExpansionLevel.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 4 expansion +---@return 0 +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---Returns the expansion level of the game. Returns the expansion level active on the current account. Differs from GetAccountExpansionLevel() as that function returns the highest purchased expansion level, while GetExpansionLevel() returns the currently active one. +function GetExpansionLevel() end \ No newline at end of file diff --git a/api/GetExpertise.lua b/api/GetExpertise.lua new file mode 100644 index 0000000..a8be5a4 --- /dev/null +++ b/api/GetExpertise.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number expertise +---Returns the player's current expertise value +function GetExpertise() end \ No newline at end of file diff --git a/api/GetExtendedItemInfo.lua b/api/GetExtendedItemInfo.lua new file mode 100644 index 0000000..47326eb --- /dev/null +++ b/api/GetExtendedItemInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetExtendedItemInfo() end \ No newline at end of file diff --git a/api/GetExtraBarIndex.lua b/api/GetExtraBarIndex.lua new file mode 100644 index 0000000..7f9dfd7 --- /dev/null +++ b/api/GetExtraBarIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetExtraBarIndex() end \ No newline at end of file diff --git a/api/GetFacialHairCustomization.lua b/api/GetFacialHairCustomization.lua new file mode 100644 index 0000000..371ada0 --- /dev/null +++ b/api/GetFacialHairCustomization.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string token +---Returns a token used for displaying facial feature customization options. The token referred to by this function can be used to look up a global variable containing localized names for the customization options available to the player's race at character creation time and in the Barbershop UI; see example. +function GetFacialHairCustomization() end \ No newline at end of file diff --git a/api/GetFactionInfo.lua b/api/GetFactionInfo.lua new file mode 100644 index 0000000..1dea1a3 --- /dev/null +++ b/api/GetFactionInfo.lua @@ -0,0 +1,29 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---@return string description +---@return 8 standingID +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---@return 5 +---@return 6 +---@return 7 +---@return 8 +---@return number barMin +---@return number barMax +---@return number barValue +---@return 1nil atWarWith +---@return 1nil canToggleAtWar +---@return 1nil isHeader +---@return 1nil isCollapsed +---@return 1nil hasRep +---@return 1nil isWatched +---@return 1nil isChild +---@return number factionID +---@return 1nil hasBonusRepGain +---@return 1nil canBeLFGBonus +---Returns information about a faction or header listing. Returns information about factions known to the player as listed in the player's Reputation UI; for information about any faction given its unique identifier, see GetFactionInfoByID. +function GetFactionInfo(index) end \ No newline at end of file diff --git a/api/GetFactionInfoByID.lua b/api/GetFactionInfoByID.lua new file mode 100644 index 0000000..bd204d3 --- /dev/null +++ b/api/GetFactionInfoByID.lua @@ -0,0 +1,29 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param factionID number +---@return string name +---@return string description +---@return 8 standingID +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---@return 5 +---@return 6 +---@return 7 +---@return 8 +---@return number barMin +---@return number barMax +---@return number barValue +---@return 1nil atWarWith +---@return 1nil canToggleAtWar +---@return 1nil isHeader +---@return 1nil isCollapsed +---@return 1nil hasRep +---@return 1nil isWatched +---@return 1nil isChild +---@return number factionID +---@return 1nil hasBonusRepGain +---@return 1nil canBeLFGBonus +---Returns information about a faction or header listing. Returns information about a faction regardless of whether the faction is known to the player (indeed, even for factions only available to the opposing alliance); see GetFactionInfo for information about factions listed in the player's Reputation UI. Faction IDs used by this function match those found on database sites (e.g. Guardians of Hyjal) and are also returned by GetQuestLogRewardFactionInfo. +function GetFactionInfoByID(factionID) end \ No newline at end of file diff --git a/api/GetFirstTradeSkill.lua b/api/GetFirstTradeSkill.lua new file mode 100644 index 0000000..19fc365 --- /dev/null +++ b/api/GetFirstTradeSkill.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number index +---Returns the index of the first non-header in the trade skill listing +function GetFirstTradeSkill() end \ No newline at end of file diff --git a/api/GetFlexRaidDungeonInfo.lua b/api/GetFlexRaidDungeonInfo.lua new file mode 100644 index 0000000..0687555 --- /dev/null +++ b/api/GetFlexRaidDungeonInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetFlexRaidDungeonInfo() end \ No newline at end of file diff --git a/api/GetFlyoutID.lua b/api/GetFlyoutID.lua new file mode 100644 index 0000000..d620f9a --- /dev/null +++ b/api/GetFlyoutID.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number flyoutID +---Returns the internal flyoutID for a given flyout index. The input parameter index is from 1 to the number provided by GetNumFlyouts() +function GetFlyoutID(index) end \ No newline at end of file diff --git a/api/GetFlyoutInfo.lua b/api/GetFlyoutInfo.lua new file mode 100644 index 0000000..8af6d7d --- /dev/null +++ b/api/GetFlyoutInfo.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@return string name +---@return string description +---@return number numSlots +---@return boolean isKnown +---Returns information about a flyout slot. Flyout IDs are provided by GetFlyoutID(index). +function GetFlyoutInfo(id) end \ No newline at end of file diff --git a/api/GetFlyoutSlotInfo.lua b/api/GetFlyoutSlotInfo.lua new file mode 100644 index 0000000..8548f63 --- /dev/null +++ b/api/GetFlyoutSlotInfo.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param flyoutID number +---@param slot number +---@return number spellID +---@return boolean isKnown +---Returns information about a flyout ability slot +function GetFlyoutSlotInfo(flyoutID, slot) end \ No newline at end of file diff --git a/api/GetFrameCPUUsage.lua b/api/GetFrameCPUUsage.lua new file mode 100644 index 0000000..99465b8 --- /dev/null +++ b/api/GetFrameCPUUsage.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param frame table +---@param includeChildren boolean +---@return number usage +---@return number calls +---Returns information about CPU usage by a frame's script handlers. Only returns valid data if the scriptProfile CVar was set to 1 on last UI reload; returns 0 otherwise. OnUpdate CPU usage is not included (tested at ver 6.0.3). Other scripts (e.g. OnEvent, OnShow) are included. Note that the CPU time is the sum of the time spent in the frame's CURRENT script handler functions, so if you change the handlers, or nil them out, the reported CPU time will change. +function GetFrameCPUUsage(frame, includeChildren) end \ No newline at end of file diff --git a/api/GetFramerate.lua b/api/GetFramerate.lua new file mode 100644 index 0000000..8f02863 --- /dev/null +++ b/api/GetFramerate.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number framerate +---Returns the number of frames per second rendered by the client +function GetFramerate() end \ No newline at end of file diff --git a/api/GetFramesRegisteredForEvent.lua b/api/GetFramesRegisteredForEvent.lua new file mode 100644 index 0000000..8f8bfd6 --- /dev/null +++ b/api/GetFramesRegisteredForEvent.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param event string +---@return list ... +---Returns all frames registered for a given event +function GetFramesRegisteredForEvent(event) end \ No newline at end of file diff --git a/api/GetFriendInfo.lua b/api/GetFriendInfo.lua new file mode 100644 index 0000000..f71355f --- /dev/null +++ b/api/GetFriendInfo.lua @@ -0,0 +1,13 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---@return number level +---@return string class +---@return string area +---@return 1nil connected +---@return string status +---@return string note +---@return 1nil RAF +---Returns information about a character on the player's friends list +function GetFriendInfo(index) end \ No newline at end of file diff --git a/api/GetFunctionCPUUsage.lua b/api/GetFunctionCPUUsage.lua new file mode 100644 index 0000000..96dba6f --- /dev/null +++ b/api/GetFunctionCPUUsage.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param function function +---@param includeSubroutines boolean +---@return number usage +---@return number calls +---Returns information about CPU usage by a function. Only returns valid data if the scriptProfile CVar is set to 1; returns 0 otherwise. +function GetFunctionCPUUsage(function, includeSubroutines) end \ No newline at end of file diff --git a/api/GetGMStatus.lua b/api/GetGMStatus.lua new file mode 100644 index 0000000..a70b025 --- /dev/null +++ b/api/GetGMStatus.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGMStatus() end \ No newline at end of file diff --git a/api/GetGMTicket.lua b/api/GetGMTicket.lua new file mode 100644 index 0000000..a3ba155 --- /dev/null +++ b/api/GetGMTicket.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Requests GM ticket status from the server. The UPDATE_TICKET event fires when data is ready. +function GetGMTicket() end \ No newline at end of file diff --git a/api/GetGMTicketCategories.lua b/api/GetGMTicketCategories.lua new file mode 100644 index 0000000..2aa1028 --- /dev/null +++ b/api/GetGMTicketCategories.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string ... +---Returns a list of available GM ticket categories. No longer used in the current GM Help UI. +function GetGMTicketCategories() end \ No newline at end of file diff --git a/api/GetGameTime.lua b/api/GetGameTime.lua new file mode 100644 index 0000000..5edf3c2 --- /dev/null +++ b/api/GetGameTime.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number hour +---@return number minute +---Returns the current realm (server) time. Warning! When player is on an instance server (Dungeon, Arena, Battleground) GetGameTime() might return different server time than on the player server. This is caused by fact that some instance servers run in different timezone that players servers. +function GetGameTime() end \ No newline at end of file diff --git a/api/GetGamma.lua b/api/GetGamma.lua new file mode 100644 index 0000000..8a0010c --- /dev/null +++ b/api/GetGamma.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number gamma +---Returns the current display gamma setting. Gamma value determines the contrast between lighter and darker portions of the game display; for a detailed explanation see the Wikipedia entry on Gamma correction entry. +function GetGamma() end \ No newline at end of file diff --git a/api/GetGlyphClearInfo.lua b/api/GetGlyphClearInfo.lua new file mode 100644 index 0000000..7c1a79d --- /dev/null +++ b/api/GetGlyphClearInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGlyphClearInfo() end \ No newline at end of file diff --git a/api/GetGlyphInfo.lua b/api/GetGlyphInfo.lua new file mode 100644 index 0000000..f52fc69 --- /dev/null +++ b/api/GetGlyphInfo.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---@return number glyphType +---@return boolean isKnown +---@return string icon +---@return number castSpell +---Returns information about a glyph in the glyph list. This function is used to iterate through all the glyphs the current class can use, whether known or not. The spell ID referenced in the fifth return castSpell refers to the spell used to put the glyph in the socket -- not the Inscription spell that creates a glyph item, but the spell associated with that item's "Use:" effect. +function GetGlyphInfo(index) end \ No newline at end of file diff --git a/api/GetGlyphLink.lua b/api/GetGlyphLink.lua new file mode 100644 index 0000000..4fd3a36 --- /dev/null +++ b/api/GetGlyphLink.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param socket number +---@param talentGroup nil +---@param 1 +---@param 2 +---@param nil +---@return string link +---Gets a hyperlink for the contents of a glyph socket. Glyph links are distinct from item and spell links: e.g. "|cff66bbff|Hglyph:21:361|h[Glyph of Hunter's Mark]|h|r". +function GetGlyphLink(socket, talentGroup, 1, 2, nil) end \ No newline at end of file diff --git a/api/GetGlyphLinkByID.lua b/api/GetGlyphLinkByID.lua new file mode 100644 index 0000000..bea18f0 --- /dev/null +++ b/api/GetGlyphLinkByID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGlyphLinkByID() end \ No newline at end of file diff --git a/api/GetGlyphSocketInfo.lua b/api/GetGlyphSocketInfo.lua new file mode 100644 index 0000000..feb2129 --- /dev/null +++ b/api/GetGlyphSocketInfo.lua @@ -0,0 +1,14 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param socket number +---@param talentGroup nil +---@param 1 +---@param 2 +---@param nil +---@return boolean enabled +---@return number glyphType +---@return number glyphTooltipIndex +---@return number glyphSpell +---@return string icon +---Returns information about a glyph socket and its contents. The spell ID referenced in the third return glyphSpell refers to the spell used to put the glyph in the socket -- not the Inscription spell that creates a glyph item, but the spell associated with that item's "Use:" effect. +function GetGlyphSocketInfo(socket, talentGroup, 1, 2, nil) end \ No newline at end of file diff --git a/api/GetGossipActiveQuests.lua b/api/GetGossipActiveQuests.lua new file mode 100644 index 0000000..bd5c90c --- /dev/null +++ b/api/GetGossipActiveQuests.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string name +---@return number level +---@return 1nil isTrivial +---@return 1nil isComplete +---@return 1nil isLegendary +---@return list ... +---Returns a list of quests which can be turned in to the current Gossip NPC. For quests offered by the NPC, see GetGossipAvailableQuests(). +function GetGossipActiveQuests() end \ No newline at end of file diff --git a/api/GetGossipAvailableQuests.lua b/api/GetGossipAvailableQuests.lua new file mode 100644 index 0000000..5c0d55e --- /dev/null +++ b/api/GetGossipAvailableQuests.lua @@ -0,0 +1,14 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string name +---@return number level +---@return boolean isTrivial +---@return LE_QUEST_FREQUENCY_WEEKLY frequency +---@return 1 +---@return LE_QUEST_FREQUENCY_DAILY +---@return LE_QUEST_FREQUENCY_WEEKLY +---@return boolean isRepeatable +---@return boolean isLegendary +---@return list ... +---Returns a list of quests available from the current Gossip NPC. For quests which can be turned in to the NPC, see GetGossipActiveQuests(). +function GetGossipAvailableQuests() end \ No newline at end of file diff --git a/api/GetGossipOptions.lua b/api/GetGossipOptions.lua new file mode 100644 index 0000000..f7eb81f --- /dev/null +++ b/api/GetGossipOptions.lua @@ -0,0 +1,15 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string text +---@return Vendor gossipType +---@return Banker +---@return BattleMaster +---@return Binder +---@return Gossip +---@return Tabard +---@return Taxi +---@return Trainer +---@return Vendor +---@return list ... +---Returns a list of interaction options for the Gossip NPC +function GetGossipOptions() end \ No newline at end of file diff --git a/api/GetGossipText.lua b/api/GetGossipText.lua new file mode 100644 index 0000000..0121b88 --- /dev/null +++ b/api/GetGossipText.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string text +---Returns greeting or other text to be displayed in an NPC dialog +function GetGossipText() end \ No newline at end of file diff --git a/api/GetGraphicsAPIs.lua b/api/GetGraphicsAPIs.lua new file mode 100644 index 0000000..b7a3ff2 --- /dev/null +++ b/api/GetGraphicsAPIs.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGraphicsAPIs() end \ No newline at end of file diff --git a/api/GetGreetingText.lua b/api/GetGreetingText.lua new file mode 100644 index 0000000..76f48f2 --- /dev/null +++ b/api/GetGreetingText.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string greetingText +---Returns the greeting text displayed for quest NPCs with multiple quests. Not used often; most quest NPCs offering multiple quests (and/or other options) use the Gossip functions to provide a greeting (see GetGossipText()). +function GetGreetingText() end \ No newline at end of file diff --git a/api/GetGuildAchievementMemberInfo.lua b/api/GetGuildAchievementMemberInfo.lua new file mode 100644 index 0000000..a96f170 --- /dev/null +++ b/api/GetGuildAchievementMemberInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGuildAchievementMemberInfo() end \ No newline at end of file diff --git a/api/GetGuildAchievementMembers.lua b/api/GetGuildAchievementMembers.lua new file mode 100644 index 0000000..1c6367a --- /dev/null +++ b/api/GetGuildAchievementMembers.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGuildAchievementMembers() end \ No newline at end of file diff --git a/api/GetGuildAchievementNumMembers.lua b/api/GetGuildAchievementNumMembers.lua new file mode 100644 index 0000000..1f23cc4 --- /dev/null +++ b/api/GetGuildAchievementNumMembers.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGuildAchievementNumMembers() end \ No newline at end of file diff --git a/api/GetGuildApplicantInfo.lua b/api/GetGuildApplicantInfo.lua new file mode 100644 index 0000000..665f26d --- /dev/null +++ b/api/GetGuildApplicantInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGuildApplicantInfo() end \ No newline at end of file diff --git a/api/GetGuildApplicantSelection.lua b/api/GetGuildApplicantSelection.lua new file mode 100644 index 0000000..2b054e7 --- /dev/null +++ b/api/GetGuildApplicantSelection.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGuildApplicantSelection() end \ No newline at end of file diff --git a/api/GetGuildBankBonusDepositMoney.lua b/api/GetGuildBankBonusDepositMoney.lua new file mode 100644 index 0000000..a4e3ed1 --- /dev/null +++ b/api/GetGuildBankBonusDepositMoney.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGuildBankBonusDepositMoney() end \ No newline at end of file diff --git a/api/GetGuildBankItemInfo.lua b/api/GetGuildBankItemInfo.lua new file mode 100644 index 0000000..9924f80 --- /dev/null +++ b/api/GetGuildBankItemInfo.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param tab number +---@param slot number +---@return string texture +---@return number count +---@return 1nil locked +---Returns information about the contents of a guild bank item slot +function GetGuildBankItemInfo(tab, slot) end \ No newline at end of file diff --git a/api/GetGuildBankItemLink.lua b/api/GetGuildBankItemLink.lua new file mode 100644 index 0000000..8f38348 --- /dev/null +++ b/api/GetGuildBankItemLink.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param tab number +---@param slot number +---@return string item +---Returns a hyperlink for an item in the guild bank +function GetGuildBankItemLink(tab, slot) end \ No newline at end of file diff --git a/api/GetGuildBankMoney.lua b/api/GetGuildBankMoney.lua new file mode 100644 index 0000000..d28f3c7 --- /dev/null +++ b/api/GetGuildBankMoney.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number guildBankMoney +---Returns the amount of money in the guild bank. The return value is cached and returns the last value seen when not interacting with a guild bank vault. This cache works across characters, and is updated when the GUILDBANK_UPDATE_MONEY or GUILDBANKFRAME_OPENED event fires. If no player character has accessed a guild bank since the game client was launched, this function returns 0. +function GetGuildBankMoney() end \ No newline at end of file diff --git a/api/GetGuildBankMoneyTransaction.lua b/api/GetGuildBankMoneyTransaction.lua new file mode 100644 index 0000000..45bc05e --- /dev/null +++ b/api/GetGuildBankMoneyTransaction.lua @@ -0,0 +1,14 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return withdraw type +---@return deposit +---@return repair +---@return withdraw +---@return string name +---@return number year +---@return number month +---@return number day +---@return number hour +---Returns information about a transaction in the guild bank money log +function GetGuildBankMoneyTransaction(index) end \ No newline at end of file diff --git a/api/GetGuildBankTabCost.lua b/api/GetGuildBankTabCost.lua new file mode 100644 index 0000000..d425555 --- /dev/null +++ b/api/GetGuildBankTabCost.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number tabCost +---Returns the cost of the next available guild bank tab +function GetGuildBankTabCost() end \ No newline at end of file diff --git a/api/GetGuildBankTabInfo.lua b/api/GetGuildBankTabInfo.lua new file mode 100644 index 0000000..11a4ca3 --- /dev/null +++ b/api/GetGuildBankTabInfo.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param tab number +---@return string name +---@return string icon +---@return 1nil isViewable +---@return 1nil canDeposit +---@return number numWithdrawals +---@return number remainingWithdrawals +---Returns information about a guild bank tab +function GetGuildBankTabInfo(tab) end \ No newline at end of file diff --git a/api/GetGuildBankTabPermissions.lua b/api/GetGuildBankTabPermissions.lua new file mode 100644 index 0000000..31201e8 --- /dev/null +++ b/api/GetGuildBankTabPermissions.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param tab number +---@return 1nil canView +---@return 1nil canDeposit +---@return 1nil canUpdateText +---@return number numWithdrawls +---Returns information about guild bank tab privileges for the guild rank currently being edited. Used in the default UI's guild control panel. +function GetGuildBankTabPermissions(tab) end \ No newline at end of file diff --git a/api/GetGuildBankText.lua b/api/GetGuildBankText.lua new file mode 100644 index 0000000..1112fe9 --- /dev/null +++ b/api/GetGuildBankText.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param tab number +---@return string text +---Returns text associated with a guild bank tab. Only returns valid data after QueryGuildBankText() has been called to retrieve the text from the server and the following GUILDBANK_UPDATE_TEXT event has fired. +function GetGuildBankText(tab) end \ No newline at end of file diff --git a/api/GetGuildBankTransaction.lua b/api/GetGuildBankTransaction.lua new file mode 100644 index 0000000..710af09 --- /dev/null +++ b/api/GetGuildBankTransaction.lua @@ -0,0 +1,20 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param tab number +---@param index number +---@return withdraw type +---@return deposit +---@return move +---@return repair +---@return withdraw +---@return string name +---@return string itemLink +---@return number count +---@return number tab1 +---@return number tab2 +---@return number year +---@return number month +---@return number day +---@return number hour +---Returns information about a transaction in the log for a guild bank tab. Only returns valid information following the GUILDBANKLOG_UPDATE event which fires after calling QueryGuildBankLog(). +function GetGuildBankTransaction(tab, index) end \ No newline at end of file diff --git a/api/GetGuildBankWithdrawGoldLimit.lua b/api/GetGuildBankWithdrawGoldLimit.lua new file mode 100644 index 0000000..d83ce92 --- /dev/null +++ b/api/GetGuildBankWithdrawGoldLimit.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGuildBankWithdrawGoldLimit() end \ No newline at end of file diff --git a/api/GetGuildBankWithdrawMoney.lua b/api/GetGuildBankWithdrawMoney.lua new file mode 100644 index 0000000..d95dc62 --- /dev/null +++ b/api/GetGuildBankWithdrawMoney.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number withdrawLimit +---Returns the amount of money the player is allowed to withdraw from the guild bank per day +function GetGuildBankWithdrawMoney() end \ No newline at end of file diff --git a/api/GetGuildCategoryList.lua b/api/GetGuildCategoryList.lua new file mode 100644 index 0000000..672c3d3 --- /dev/null +++ b/api/GetGuildCategoryList.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return table categories +---Returns a list of all guild achievement categories +function GetGuildCategoryList() end \ No newline at end of file diff --git a/api/GetGuildChallengeInfo.lua b/api/GetGuildChallengeInfo.lua new file mode 100644 index 0000000..6d7eb42 --- /dev/null +++ b/api/GetGuildChallengeInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGuildChallengeInfo() end \ No newline at end of file diff --git a/api/GetGuildCharterCost.lua b/api/GetGuildCharterCost.lua new file mode 100644 index 0000000..d23b7e9 --- /dev/null +++ b/api/GetGuildCharterCost.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number cost +---Returns the cost to purchase a guild charter. Usable if the player is interacting with a guild registrar (i.e. between the GUILD_REGISTRAR_SHOW and GUILD_REGISTRAR_CLOSED events). +function GetGuildCharterCost() end \ No newline at end of file diff --git a/api/GetGuildEventInfo.lua b/api/GetGuildEventInfo.lua new file mode 100644 index 0000000..7cd7397 --- /dev/null +++ b/api/GetGuildEventInfo.lua @@ -0,0 +1,19 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return remove type +---@return demote +---@return invite +---@return join +---@return promote +---@return quit +---@return remove +---@return string player1 +---@return string player2 +---@return string rank +---@return number year +---@return number month +---@return number day +---@return number hour +---Returns information about an entry in the guild event log. Only returns valid data after calling QueryGuildEventLog() and the following GUILD_EVENT_LOG_UPDATE event has fired. +function GetGuildEventInfo(index) end \ No newline at end of file diff --git a/api/GetGuildExpirationTime.lua b/api/GetGuildExpirationTime.lua new file mode 100644 index 0000000..6d638d9 --- /dev/null +++ b/api/GetGuildExpirationTime.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGuildExpirationTime() end \ No newline at end of file diff --git a/api/GetGuildFactionGroup.lua b/api/GetGuildFactionGroup.lua new file mode 100644 index 0000000..d500965 --- /dev/null +++ b/api/GetGuildFactionGroup.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGuildFactionGroup() end \ No newline at end of file diff --git a/api/GetGuildFactionInfo.lua b/api/GetGuildFactionInfo.lua new file mode 100644 index 0000000..7125985 --- /dev/null +++ b/api/GetGuildFactionInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGuildFactionInfo() end \ No newline at end of file diff --git a/api/GetGuildInfo.lua b/api/GetGuildInfo.lua new file mode 100644 index 0000000..6e48e8b --- /dev/null +++ b/api/GetGuildInfo.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return string guildName +---@return string guildRankName +---@return number guildRankIndex +---Returns a unit's guild affiliation +function GetGuildInfo(unit, name) end \ No newline at end of file diff --git a/api/GetGuildInfoText.lua b/api/GetGuildInfoText.lua new file mode 100644 index 0000000..787ca30 --- /dev/null +++ b/api/GetGuildInfoText.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string guildInfoText +---Returns guild information text. Only returns valid data after calling GuildRoster() and the following GUILD_ROSTER_UPDATE event has fired. This text appears when clicking the "Guild Information" button in the default UI's Guild window. +function GetGuildInfoText() end \ No newline at end of file diff --git a/api/GetGuildLevelEnabled.lua b/api/GetGuildLevelEnabled.lua new file mode 100644 index 0000000..6598f11 --- /dev/null +++ b/api/GetGuildLevelEnabled.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGuildLevelEnabled() end \ No newline at end of file diff --git a/api/GetGuildLogoInfo.lua b/api/GetGuildLogoInfo.lua new file mode 100644 index 0000000..6f2fd0e --- /dev/null +++ b/api/GetGuildLogoInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGuildLogoInfo() end \ No newline at end of file diff --git a/api/GetGuildMemberRecipes.lua b/api/GetGuildMemberRecipes.lua new file mode 100644 index 0000000..4308a86 --- /dev/null +++ b/api/GetGuildMemberRecipes.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGuildMemberRecipes() end \ No newline at end of file diff --git a/api/GetGuildMembershipRequestInfo.lua b/api/GetGuildMembershipRequestInfo.lua new file mode 100644 index 0000000..9c0246a --- /dev/null +++ b/api/GetGuildMembershipRequestInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGuildMembershipRequestInfo() end \ No newline at end of file diff --git a/api/GetGuildMembershipRequestSettings.lua b/api/GetGuildMembershipRequestSettings.lua new file mode 100644 index 0000000..9aebc09 --- /dev/null +++ b/api/GetGuildMembershipRequestSettings.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGuildMembershipRequestSettings() end \ No newline at end of file diff --git a/api/GetGuildNewsFilters.lua b/api/GetGuildNewsFilters.lua new file mode 100644 index 0000000..271e1b0 --- /dev/null +++ b/api/GetGuildNewsFilters.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGuildNewsFilters() end \ No newline at end of file diff --git a/api/GetGuildNewsInfo.lua b/api/GetGuildNewsInfo.lua new file mode 100644 index 0000000..b673573 --- /dev/null +++ b/api/GetGuildNewsInfo.lua @@ -0,0 +1,27 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param newsIndex number +---@return boolean isSticky +---@return boolean isHeader +---@return 5 newsType +---@return 0 +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---@return 5 +---@return string text1 +---@return string text2 +---@return newsType = 5 id +---@return newsType = 0 +---@return newsType = 1 +---@return newsType = 2 +---@return newsType = 3 +---@return newsType = 4 +---@return newsType = 5 +---@return number weekday +---@return number day +---@return number month +---@return number year +---Returns information about an item of guild news +function GetGuildNewsInfo(newsIndex) end \ No newline at end of file diff --git a/api/GetGuildNewsMemberName.lua b/api/GetGuildNewsMemberName.lua new file mode 100644 index 0000000..94761e7 --- /dev/null +++ b/api/GetGuildNewsMemberName.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGuildNewsMemberName() end \ No newline at end of file diff --git a/api/GetGuildNewsSort.lua b/api/GetGuildNewsSort.lua new file mode 100644 index 0000000..bf38c47 --- /dev/null +++ b/api/GetGuildNewsSort.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGuildNewsSort() end \ No newline at end of file diff --git a/api/GetGuildPerkInfo.lua b/api/GetGuildPerkInfo.lua new file mode 100644 index 0000000..08e23c8 --- /dev/null +++ b/api/GetGuildPerkInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGuildPerkInfo() end \ No newline at end of file diff --git a/api/GetGuildRecipeInfoPostQuery.lua b/api/GetGuildRecipeInfoPostQuery.lua new file mode 100644 index 0000000..1551ae7 --- /dev/null +++ b/api/GetGuildRecipeInfoPostQuery.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGuildRecipeInfoPostQuery() end \ No newline at end of file diff --git a/api/GetGuildRecipeMember.lua b/api/GetGuildRecipeMember.lua new file mode 100644 index 0000000..3a41d53 --- /dev/null +++ b/api/GetGuildRecipeMember.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string displayName +---@return string fullName +---@return string classFileName +---@return number online +---Returns information about the selected player when viewing View Crafters under professions. +function GetGuildRecipeMember(index) end \ No newline at end of file diff --git a/api/GetGuildRecruitmentComment.lua b/api/GetGuildRecruitmentComment.lua new file mode 100644 index 0000000..ad7af8a --- /dev/null +++ b/api/GetGuildRecruitmentComment.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGuildRecruitmentComment() end \ No newline at end of file diff --git a/api/GetGuildRecruitmentSettings.lua b/api/GetGuildRecruitmentSettings.lua new file mode 100644 index 0000000..07ae765 --- /dev/null +++ b/api/GetGuildRecruitmentSettings.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGuildRecruitmentSettings() end \ No newline at end of file diff --git a/api/GetGuildRenameRequired.lua b/api/GetGuildRenameRequired.lua new file mode 100644 index 0000000..4785722 --- /dev/null +++ b/api/GetGuildRenameRequired.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGuildRenameRequired() end \ No newline at end of file diff --git a/api/GetGuildRewardInfo.lua b/api/GetGuildRewardInfo.lua new file mode 100644 index 0000000..b543110 --- /dev/null +++ b/api/GetGuildRewardInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGuildRewardInfo() end \ No newline at end of file diff --git a/api/GetGuildRosterInfo.lua b/api/GetGuildRosterInfo.lua new file mode 100644 index 0000000..32e7dd6 --- /dev/null +++ b/api/GetGuildRosterInfo.lua @@ -0,0 +1,23 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string fullName +---@return string rank +---@return number rankIndex +---@return number level +---@return string class +---@return string zone +---@return string note +---@return string officernote +---@return 1nil online +---@return 2 status +---@return 1 +---@return 2 +---@return string classFileName +---@return number achievementPoints +---@return number achievementRank +---@return number isMobile +---@return number canSoR +---@return number reputation +---Returns information about the selected player in your guild roster.. Only returns valid data after calling GuildRoster() and the following GUILD_ROSTER_UPDATE event has fired. +function GetGuildRosterInfo(index) end \ No newline at end of file diff --git a/api/GetGuildRosterLargestAchievementPoints.lua b/api/GetGuildRosterLargestAchievementPoints.lua new file mode 100644 index 0000000..00d99ca --- /dev/null +++ b/api/GetGuildRosterLargestAchievementPoints.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetGuildRosterLargestAchievementPoints() end \ No newline at end of file diff --git a/api/GetGuildRosterLastOnline.lua b/api/GetGuildRosterLastOnline.lua new file mode 100644 index 0000000..0ab1a4c --- /dev/null +++ b/api/GetGuildRosterLastOnline.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number years +---@return number months +---@return number days +---@return number hours +---Returns the amount of time since a guild member was last online. Only returns valid data after calling GuildRoster() and the following GUILD_ROSTER_UPDATE event has fired. +function GetGuildRosterLastOnline(index) end \ No newline at end of file diff --git a/api/GetGuildRosterMOTD.lua b/api/GetGuildRosterMOTD.lua new file mode 100644 index 0000000..c63be9f --- /dev/null +++ b/api/GetGuildRosterMOTD.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string guildMOTD +---Returns the Message of the Day for the player's guild +function GetGuildRosterMOTD() end \ No newline at end of file diff --git a/api/GetGuildRosterSelection.lua b/api/GetGuildRosterSelection.lua new file mode 100644 index 0000000..3de3921 --- /dev/null +++ b/api/GetGuildRosterSelection.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number index +---Returns the index of the selected member in the guild roster. Selection in the guild roster is used only for display in the default UI and has no effect on other Guild APIs. +function GetGuildRosterSelection() end \ No newline at end of file diff --git a/api/GetGuildRosterShowOffline.lua b/api/GetGuildRosterShowOffline.lua new file mode 100644 index 0000000..dd3da79 --- /dev/null +++ b/api/GetGuildRosterShowOffline.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil showOffline +---Returns whether the guild roster lists offline members +function GetGuildRosterShowOffline() end \ No newline at end of file diff --git a/api/GetGuildTabardFileNames.lua b/api/GetGuildTabardFileNames.lua new file mode 100644 index 0000000..2a99cfc --- /dev/null +++ b/api/GetGuildTabardFileNames.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string tabardBackgroundUpper +---@return string tabardBackgroundLower +---@return string tabardEmblemUpper +---@return string tabardEmblemLower +---@return string tabardBorderUpper +---@return string tabardBorderLower +---Returns the textures that comprise the player's guild tabard. Returns nil if the player is not in a guild. +function GetGuildTabardFileNames() end \ No newline at end of file diff --git a/api/GetGuildTradeSkillInfo.lua b/api/GetGuildTradeSkillInfo.lua new file mode 100644 index 0000000..f978b91 --- /dev/null +++ b/api/GetGuildTradeSkillInfo.lua @@ -0,0 +1,20 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number professionID +---@return boolean or nil isCollapsed +---@return string iconTexture +---@return string headerName +---@return number numOnline +---@return number numVisible +---@return number numPlayers +---@return string playerName +---@return string playerNameWithRealm +---@return string class +---@return 1 or nil online +---@return string zone +---@return number skill +---@return string classFileName +---@return boolean isMobile +---Returns information about the specified guild profession entry.. Returns information about the specified guild profession entry (crafter or header). +function GetGuildTradeSkillInfo(index) end \ No newline at end of file diff --git a/api/GetHairCustomization.lua b/api/GetHairCustomization.lua new file mode 100644 index 0000000..bcacdd1 --- /dev/null +++ b/api/GetHairCustomization.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string token +---Returns a token used for displaying "hair" customization options. The token referred to by this function can be used to look up a global variable containing localized names for the customization options available to the player's race at character creation time and in the Barbershop UI; see example. +function GetHairCustomization() end \ No newline at end of file diff --git a/api/GetHaste.lua b/api/GetHaste.lua new file mode 100644 index 0000000..a495e10 --- /dev/null +++ b/api/GetHaste.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Returns information about the players Haste percentage. +function GetHaste() end \ No newline at end of file diff --git a/api/GetHitModifier.lua b/api/GetHitModifier.lua new file mode 100644 index 0000000..52bf3d3 --- /dev/null +++ b/api/GetHitModifier.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetHitModifier() end \ No newline at end of file diff --git a/api/GetHolidayBGHonorCurrencyBonuses.lua b/api/GetHolidayBGHonorCurrencyBonuses.lua new file mode 100644 index 0000000..e0a9f7a --- /dev/null +++ b/api/GetHolidayBGHonorCurrencyBonuses.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean unk +---@return number honorWinReward +---@return number arenaWinReward +---@return number honorLossReward +---@return number arenaLossReward +---Returns the awarded honor and arena points for a Call to Arms battleground win or loss +function GetHolidayBGHonorCurrencyBonuses() end \ No newline at end of file diff --git a/api/GetHomePartyInfo.lua b/api/GetHomePartyInfo.lua new file mode 100644 index 0000000..de3ba5c --- /dev/null +++ b/api/GetHomePartyInfo.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return table names +---Returns a list of player names in the player's party or raid +function GetHomePartyInfo() end \ No newline at end of file diff --git a/api/GetIgnoreName.lua b/api/GetIgnoreName.lua new file mode 100644 index 0000000..00a20fb --- /dev/null +++ b/api/GetIgnoreName.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index string +---@return string name +---Returns the name of a character on the ignore list +function GetIgnoreName(index) end \ No newline at end of file diff --git a/api/GetInboxHeaderInfo.lua b/api/GetInboxHeaderInfo.lua new file mode 100644 index 0000000..cae2ce8 --- /dev/null +++ b/api/GetInboxHeaderInfo.lua @@ -0,0 +1,19 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param mailID number +---@return string packageIcon +---@return string stationeryIcon +---@return string sender +---@return string subject +---@return number money +---@return number CODAmount +---@return number daysLeft +---@return number itemCount +---@return 1nil wasRead +---@return 1nil wasReturned +---@return 1nil textCreated +---@return 1nil canReply +---@return 1nil isGM +---@return number itemQuantity +---Returns information about a mail in the player's inbox +function GetInboxHeaderInfo(mailID) end \ No newline at end of file diff --git a/api/GetInboxInvoiceInfo.lua b/api/GetInboxInvoiceInfo.lua new file mode 100644 index 0000000..243d89f --- /dev/null +++ b/api/GetInboxInvoiceInfo.lua @@ -0,0 +1,18 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return seller_temp_invoice invoiceType +---@return buyer +---@return seller +---@return seller_temp_invoice +---@return string itemName +---@return string playerName +---@return number bid +---@return number buyout +---@return number deposit +---@return number consignment +---@return number moneyDelay +---@return number etaHour +---@return number etaMin +---Returns auction house invoice information for a mail +function GetInboxInvoiceInfo(index) end \ No newline at end of file diff --git a/api/GetInboxItem.lua b/api/GetInboxItem.lua new file mode 100644 index 0000000..d8530a6 --- /dev/null +++ b/api/GetInboxItem.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param mailID number +---@param attachmentIndex number +---@return string name +---@return string itemTexture +---@return number count +---@return number quality +---@return 1nil canUse +---Returns information for an item attached to a mail in the player's inbox +function GetInboxItem(mailID, attachmentIndex) end \ No newline at end of file diff --git a/api/GetInboxItemLink.lua b/api/GetInboxItemLink.lua new file mode 100644 index 0000000..2b33e75 --- /dev/null +++ b/api/GetInboxItemLink.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param mailID number +---@param attachmentIndex number +---@return string itemlink +---Returns a hyperlink for an item attached to a mail in the player's inbox +function GetInboxItemLink(mailID, attachmentIndex) end \ No newline at end of file diff --git a/api/GetInboxNumItems.lua b/api/GetInboxNumItems.lua new file mode 100644 index 0000000..7e32a69 --- /dev/null +++ b/api/GetInboxNumItems.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numItems +---@return number totalItems +---Returns the number of mails in the player's inbox +function GetInboxNumItems() end \ No newline at end of file diff --git a/api/GetInboxText.lua b/api/GetInboxText.lua new file mode 100644 index 0000000..cc703f7 --- /dev/null +++ b/api/GetInboxText.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param mailID number +---@return string bodyText +---@return string texture +---@return 1nil isTakeable +---@return 1nil isInvoice +---Returns information about the text of an inbox mail. Also marks the mail as read if it wasn't already. +function GetInboxText(mailID) end \ No newline at end of file diff --git a/api/GetInspectArenaData.lua b/api/GetInspectArenaData.lua new file mode 100644 index 0000000..2653db9 --- /dev/null +++ b/api/GetInspectArenaData.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetInspectArenaData() end \ No newline at end of file diff --git a/api/GetInspectGlyph.lua b/api/GetInspectGlyph.lua new file mode 100644 index 0000000..fcd7356 --- /dev/null +++ b/api/GetInspectGlyph.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetInspectGlyph() end \ No newline at end of file diff --git a/api/GetInspectGuildInfo.lua b/api/GetInspectGuildInfo.lua new file mode 100644 index 0000000..b0241ca --- /dev/null +++ b/api/GetInspectGuildInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetInspectGuildInfo() end \ No newline at end of file diff --git a/api/GetInspectHonorData.lua b/api/GetInspectHonorData.lua new file mode 100644 index 0000000..81a62a6 --- /dev/null +++ b/api/GetInspectHonorData.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number todayHK +---@return number todayHonor +---@return number yesterdayHK +---@return number yesterdayHonor +---@return number lifetimeHK +---@return number lifetimeRank +---Returns PvP honor information about the currently inspected unit. Only available if data has been downloaded from the server; see HasInspectHonorData() and RequestInspectHonorData(). +function GetInspectHonorData() end \ No newline at end of file diff --git a/api/GetInspectRatedBGData.lua b/api/GetInspectRatedBGData.lua new file mode 100644 index 0000000..28620d8 --- /dev/null +++ b/api/GetInspectRatedBGData.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetInspectRatedBGData() end \ No newline at end of file diff --git a/api/GetInspectSpecialization.lua b/api/GetInspectSpecialization.lua new file mode 100644 index 0000000..7e8b7c7 --- /dev/null +++ b/api/GetInspectSpecialization.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number specID +---Return specialization global ID of inspected player. +function GetInspectSpecialization() end \ No newline at end of file diff --git a/api/GetInspectTalent.lua b/api/GetInspectTalent.lua new file mode 100644 index 0000000..2937b94 --- /dev/null +++ b/api/GetInspectTalent.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetInspectTalent() end \ No newline at end of file diff --git a/api/GetInstanceBootTimeRemaining.lua b/api/GetInstanceBootTimeRemaining.lua new file mode 100644 index 0000000..75691f2 --- /dev/null +++ b/api/GetInstanceBootTimeRemaining.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number timeleft +---Returns the amount of time left until the player is removed from the current instance. Used when the player is in an instance he doesn't own; e.g. if the player enters an instance with a group and is then removed from the group. +function GetInstanceBootTimeRemaining() end \ No newline at end of file diff --git a/api/GetInstanceInfo.lua b/api/GetInstanceInfo.lua new file mode 100644 index 0000000..b9afb08 --- /dev/null +++ b/api/GetInstanceInfo.lua @@ -0,0 +1,44 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string name +---@return scenario type +---@return arena +---@return none +---@return party +---@return pvp +---@return raid +---@return scenario +---@return 24 difficulty +---@return 0 +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---@return 5 +---@return 6 +---@return 7 +---@return 8 +---@return 9 +---@return 10 +---@return 11 +---@return 12 +---@return 13 +---@return 14 +---@return 15 +---@return 16 +---@return 17 +---@return 18 +---@return 19 +---@return 20 +---@return 21 +---@return 22 +---@return 23 +---@return 24 +---@return string difficultyName +---@return number maxPlayers +---@return number playerDifficulty +---@return boolean isDynamicInstance +---@return number mapID +---@return number instanceGroupSize +---Returns instance information about the current area +function GetInstanceInfo() end \ No newline at end of file diff --git a/api/GetInstanceLockTimeRemaining.lua b/api/GetInstanceLockTimeRemaining.lua new file mode 100644 index 0000000..c664fdf --- /dev/null +++ b/api/GetInstanceLockTimeRemaining.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number seconds +---Returns time remaining before the player is saved to a recently entered instance. Applies when the player enters an instance to which other members of her group are saved; if the player leaves the instance (normally or with RespondInstanceLock(false)) within this time limit she will not be saved to the instance. +function GetInstanceLockTimeRemaining() end \ No newline at end of file diff --git a/api/GetInstanceLockTimeRemainingEncounter.lua b/api/GetInstanceLockTimeRemainingEncounter.lua new file mode 100644 index 0000000..657e757 --- /dev/null +++ b/api/GetInstanceLockTimeRemainingEncounter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetInstanceLockTimeRemainingEncounter() end \ No newline at end of file diff --git a/api/GetInventoryAlertStatus.lua b/api/GetInventoryAlertStatus.lua new file mode 100644 index 0000000..34d25d1 --- /dev/null +++ b/api/GetInventoryAlertStatus.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return 2 status +---@return 0 +---@return 1 +---@return 2 +---Returns the durability warning status of an equipped item. Looking up the status returned by this function in the INVENTORY_ALERT_COLORS table provides color values, used in the default UI to highlight parts of the DurabiltyFrame (i.e. the "armored man" image) that appears when durability is low. +function GetInventoryAlertStatus(slot) end \ No newline at end of file diff --git a/api/GetInventoryItemBroken.lua b/api/GetInventoryItemBroken.lua new file mode 100644 index 0000000..88682e6 --- /dev/null +++ b/api/GetInventoryItemBroken.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param slot number +---@return 1nil isBroken +---Returns whether an equipped item is broken +function GetInventoryItemBroken(unit, slot) end \ No newline at end of file diff --git a/api/GetInventoryItemCooldown.lua b/api/GetInventoryItemCooldown.lua new file mode 100644 index 0000000..41b0642 --- /dev/null +++ b/api/GetInventoryItemCooldown.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param slot number +---@return number start +---@return number duration +---@return number enable +---Returns cooldown information about an equipped item +function GetInventoryItemCooldown(unit, slot) end \ No newline at end of file diff --git a/api/GetInventoryItemCount.lua b/api/GetInventoryItemCount.lua new file mode 100644 index 0000000..1fd0c81 --- /dev/null +++ b/api/GetInventoryItemCount.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param slot number +---@return number count +---Returns the number of items stacked in an inventory slot. Currently only returns meaningful information for the ammo slot. +function GetInventoryItemCount(unit, slot) end \ No newline at end of file diff --git a/api/GetInventoryItemDurability.lua b/api/GetInventoryItemDurability.lua new file mode 100644 index 0000000..3273143 --- /dev/null +++ b/api/GetInventoryItemDurability.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return number durability +---@return number max +---Returns the current durability level of an equipped item. If an item does not have durability (for example, heirlooms, tabards and some other items) then this function will simply return nil. +function GetInventoryItemDurability(slot) end \ No newline at end of file diff --git a/api/GetInventoryItemEquippedUnusable.lua b/api/GetInventoryItemEquippedUnusable.lua new file mode 100644 index 0000000..ced57e3 --- /dev/null +++ b/api/GetInventoryItemEquippedUnusable.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetInventoryItemEquippedUnusable() end \ No newline at end of file diff --git a/api/GetInventoryItemGems.lua b/api/GetInventoryItemGems.lua new file mode 100644 index 0000000..77b02d9 --- /dev/null +++ b/api/GetInventoryItemGems.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return itemID gem1 +---@return itemID gem2 +---@return itemID gem3 +---Returns the gems socketed in an equipped item. The IDs returned refer to the gems themselves (not the enchantments they provide), and thus can be passed to GetItemInfo() to get a gem's name, quality, icon, etc. +function GetInventoryItemGems(slot) end \ No newline at end of file diff --git a/api/GetInventoryItemID.lua b/api/GetInventoryItemID.lua new file mode 100644 index 0000000..443046a --- /dev/null +++ b/api/GetInventoryItemID.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param slot number +---@return itemID id +---Returns the item ID of an equipped item. The results of this function can be used with GetInventorySlotInfo() and other related inventory functions. If the player beign /inspected has used transmorgification on the slot, then the itemID of the transmorgified item is what is returned, not the actual item equipped. +function GetInventoryItemID(unit, slot) end \ No newline at end of file diff --git a/api/GetInventoryItemLink.lua b/api/GetInventoryItemLink.lua new file mode 100644 index 0000000..bd9c7f3 --- /dev/null +++ b/api/GetInventoryItemLink.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param slot number +---@return string link +---Returns an item link for an item in the unit's inventory. The player's inventory is actually extended to include items in the bank, items in the player's containers and the player's key ring in addition to the items the player has equipped. The appropriate inventoryID can be found by calling the appropriate function. +function GetInventoryItemLink(unit, slot) end \ No newline at end of file diff --git a/api/GetInventoryItemQuality.lua b/api/GetInventoryItemQuality.lua new file mode 100644 index 0000000..7199e42 --- /dev/null +++ b/api/GetInventoryItemQuality.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param slot number +---@return number quality +---Returns the quality level of an equipped item +function GetInventoryItemQuality(unit, slot) end \ No newline at end of file diff --git a/api/GetInventoryItemTexture.lua b/api/GetInventoryItemTexture.lua new file mode 100644 index 0000000..6a196b6 --- /dev/null +++ b/api/GetInventoryItemTexture.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param slot number +---@return string texture +---Returns the icon texture for an equipped item +function GetInventoryItemTexture(unit, slot) end \ No newline at end of file diff --git a/api/GetInventoryItemsForSlot.lua b/api/GetInventoryItemsForSlot.lua new file mode 100644 index 0000000..d87654e --- /dev/null +++ b/api/GetInventoryItemsForSlot.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return table availableItems +---Returns a list of items that can be equipped in a given inventory slot +function GetInventoryItemsForSlot(slot) end \ No newline at end of file diff --git a/api/GetInventorySlotInfo.lua b/api/GetInventorySlotInfo.lua new file mode 100644 index 0000000..f4368fa --- /dev/null +++ b/api/GetInventorySlotInfo.lua @@ -0,0 +1,32 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slotName WristSlot +---@param AmmoSlot +---@param BackSlot +---@param Bag0Slot +---@param Bag1Slot +---@param Bag2Slot +---@param Bag3Slot +---@param ChestSlot +---@param FeetSlot +---@param Finger0Slot +---@param Finger1Slot +---@param HandsSlot +---@param HeadSlot +---@param LegsSlot +---@param MainHandSlot +---@param NeckSlot +---@param RangedSlot +---@param SecondaryHandSlot +---@param ShirtSlot +---@param ShoulderSlot +---@param TabardSlot +---@param Trinket0Slot +---@param Trinket1Slot +---@param WaistSlot +---@param WristSlot +---@return number id +---@return string texture +---@return 1nil checkRelic +---Returns information about an inventory slot +function GetInventorySlotInfo(slotName, AmmoSlot, BackSlot, Bag0Slot, Bag1Slot, Bag2Slot, Bag3Slot, ChestSlot, FeetSlot, Finger0Slot, Finger1Slot, HandsSlot, HeadSlot, LegsSlot, MainHandSlot, NeckSlot, RangedSlot, SecondaryHandSlot, ShirtSlot, ShoulderSlot, TabardSlot, Trinket0Slot, Trinket1Slot, WaistSlot, WristSlot) end \ No newline at end of file diff --git a/api/GetItemCooldown.lua b/api/GetItemCooldown.lua new file mode 100644 index 0000000..45018d6 --- /dev/null +++ b/api/GetItemCooldown.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemID number +---@param itemName string +---@param itemLink string +---@return number start +---@return number duration +---@return number enable +---Returns cooldown information about an arbitrary item +function GetItemCooldown(itemID, itemName, itemLink) end \ No newline at end of file diff --git a/api/GetItemCount.lua b/api/GetItemCount.lua new file mode 100644 index 0000000..de60f02 --- /dev/null +++ b/api/GetItemCount.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemId number +---@param itemName string +---@param itemLink string +---@param includeBank boolean +---@param includeCharges boolean +---@return number itemCount +---Returns information about how many of a given item the player has or on remaining item charges. When the third argument includeCharges is true, the returned number indicates the total number of remaining charges for the item instead of how many of the item you have; e.g. if you have 3 Wizard Oils and one of them has been used twice, the returned value will be 13. +function GetItemCount(itemId, itemName, itemLink, includeBank, includeCharges) end \ No newline at end of file diff --git a/api/GetItemFamily.lua b/api/GetItemFamily.lua new file mode 100644 index 0000000..444783e --- /dev/null +++ b/api/GetItemFamily.lua @@ -0,0 +1,25 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemID number +---@param itemName string +---@param itemLink string +---@return 0x10000 bagType +---@return 0x0001 +---@return 0x0002 +---@return 0x0004 +---@return 0x0008 +---@return 0x0010 +---@return 0x0020 +---@return 0x0040 +---@return 0x0080 +---@return 0x0100 +---@return 0x0200 +---@return 0x0400 +---@return 0x0800 +---@return 0x1000 +---@return 0x2000 +---@return 0x4000 +---@return 0x8000 +---@return 0x10000 +---Returns information about special bag types that can hold a given item. The meaning of bagType varies depending on the item: If the item is a container, bagType indicates which kinds of items the container is limited to holding; a bagType of 0 indicates the container can hold any kind of item. If the item is not a container, bagType indicates which kinds of specialty containers can hold the item; a bagType of 0 indicates the item can only be put in general-purpose containers. +function GetItemFamily(itemID, itemName, itemLink) end \ No newline at end of file diff --git a/api/GetItemGem.lua b/api/GetItemGem.lua new file mode 100644 index 0000000..4e2144f --- /dev/null +++ b/api/GetItemGem.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemID number +---@param itemName string +---@param itemLink string +---@param index number +---@return string name +---@return string link +---Returns information about gems socketed in an item +function GetItemGem(itemID, itemName, itemLink, index) end \ No newline at end of file diff --git a/api/GetItemIcon.lua b/api/GetItemIcon.lua new file mode 100644 index 0000000..2765115 --- /dev/null +++ b/api/GetItemIcon.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemID number +---@param itemName string +---@param itemLink string +---@return string texture +---Returns the path to an icon texture for the item. Unlike GetItemInfo, this function always returns icons for valid items, even if the item is not in the client's cache. +function GetItemIcon(itemID, itemName, itemLink) end \ No newline at end of file diff --git a/api/GetItemInfo.lua b/api/GetItemInfo.lua new file mode 100644 index 0000000..7b78b6f --- /dev/null +++ b/api/GetItemInfo.lua @@ -0,0 +1,18 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemID number +---@param itemName string +---@param itemLink string +---@return string name +---@return string link +---@return number quality +---@return number iLevel +---@return number reqLevel +---@return string class +---@return string subclass +---@return number maxStack +---@return string equipSlot +---@return string texture +---@return number vendorPrice +---Returns information about an item, by name, link or id. Will only return item information if it is directly available in memory. An item is present in memory if: It has been seen this session, OR It's present in Cache/enUS/Item-sparse.dba, where enUS is the user's locale If item information is not readily available, the client will first look on disk in DBFilesClient/Item-sparse.db2. If an item is found there, the client fires the GET_ITEM_INFO_RECEIVED event and keeps the result in memory for further GetItemInfo requests. If an item is not found on disk either, the client will send a server request for it. If the request fails, nothing happens. If the request succeeds, the client stores the item in memory and writes it to Cache/Locale/Item-sparse.dba. The client will never send more than one server request per id per session. +function GetItemInfo(itemID, itemName, itemLink) end \ No newline at end of file diff --git a/api/GetItemLevelIncrement.lua b/api/GetItemLevelIncrement.lua new file mode 100644 index 0000000..4d962b2 --- /dev/null +++ b/api/GetItemLevelIncrement.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number levelIncrement +---Returns the item level increment recieved when upgrading. The item level increment returned depends on the type of item, i.e. blue items recieve 8 levels per upgrade while epic items recieve 4 per upgrade (which costs half as much). This function can currently only be called when at the upgrade merchant. +function GetItemLevelIncrement() end \ No newline at end of file diff --git a/api/GetItemQualityColor.lua b/api/GetItemQualityColor.lua new file mode 100644 index 0000000..b62dcab --- /dev/null +++ b/api/GetItemQualityColor.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param quality number +---@return number redComponent +---@return number greenComponent +---@return number blueComponent +---@return string hexColor +---Returns color values for use in displaying items of a given quality. Color components are floating-point values between 0 (no component) and 1 (full intensity of the component). Prior to 4.2 the hexColor return was prefixed with |c now it is just the hex codes for the color. +function GetItemQualityColor(quality) end \ No newline at end of file diff --git a/api/GetItemSpecInfo.lua b/api/GetItemSpecInfo.lua new file mode 100644 index 0000000..1abe6ea --- /dev/null +++ b/api/GetItemSpecInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetItemSpecInfo() end \ No newline at end of file diff --git a/api/GetItemSpell.lua b/api/GetItemSpell.lua new file mode 100644 index 0000000..dd6195a --- /dev/null +++ b/api/GetItemSpell.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemID number +---@param itemName string +---@param itemLink string +---@return string name +---@return string rank +---Returns information about the spell cast by an item's "Use:" effect +function GetItemSpell(itemID, itemName, itemLink) end \ No newline at end of file diff --git a/api/GetItemStatDelta.lua b/api/GetItemStatDelta.lua new file mode 100644 index 0000000..7902bfa --- /dev/null +++ b/api/GetItemStatDelta.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param item1Link string +---@param item2Link string +---@param returnTable table +---@return table statTable +---Returns a summary of the difference in stat bonuses between two items. Keys in the table returned are the names of global variables containing the localized names of the stats (e.g. _G["ITEM_MOD_SPIRIT_SHORT"] = "Spirit", _G["ITEM_MOD_HIT_RATING_SHORT"] = "Hit Rating"). The optional argument returnTable allows for performance optimization in cases where this function is expected to be called repeatedly. Rather than creating new tables each time the function is called (eventually requiring garbage collection), an existing table can be recycled. (Note, however, that this function does not clear the table's contents; use wipe() first to guarantee consistent results.) +function GetItemStatDelta(item1Link, item2Link, returnTable) end \ No newline at end of file diff --git a/api/GetItemStats.lua b/api/GetItemStats.lua new file mode 100644 index 0000000..863637a --- /dev/null +++ b/api/GetItemStats.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemLink string +---@param returnTable table +---@return table statTable +---Returns a summary of an item's stat bonuses. Keys in the table returned are the names of global variables containing the localized names of the stats (e.g. _G["ITEM_MOD_SPIRIT_SHORT"] = "Spirit", _G["ITEM_MOD_HIT_RATING_SHORT"] = "Hit Rating"). The optional argument returnTable allows for performance optimization in cases where this function is expected to be called repeatedly. Rather than creating new tables each time the function is called (eventually requiring garbage collection), an existing table can be recycled. (Note, however, that this function does not clear the table's contents; use wipe() first to guarantee consistent results.) +function GetItemStats(itemLink, returnTable) end \ No newline at end of file diff --git a/api/GetItemTransmogrifyInfo.lua b/api/GetItemTransmogrifyInfo.lua new file mode 100644 index 0000000..451bce3 --- /dev/null +++ b/api/GetItemTransmogrifyInfo.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemID number +---@param itemName string +---@param itemLink string +---@return boolean canBeChanged +---@return string noChangeReason +---@return boolean canBeSource +---@return string noSourceReason +---Returns information about the eligibility of an item to be used for transmogrification +function GetItemTransmogrifyInfo(itemID, itemName, itemLink) end \ No newline at end of file diff --git a/api/GetItemUniqueness.lua b/api/GetItemUniqueness.lua new file mode 100644 index 0000000..b0c3c1a --- /dev/null +++ b/api/GetItemUniqueness.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemID number +---@param itemName string +---@param itemLink string +---@return number uniqueFamily +---@return number maxEquipped +---Returns information about uniqueness restrictions for equipping an item. Only applies to items with "Unique Equipped" restrictions upon how many similar items can be equipped -- returns nil for items which for which "Unique" restricts how many the player can have in her possession. Also returns nil if the queried item is not currently in the WoW client's item cache. +function GetItemUniqueness(itemID, itemName, itemLink) end \ No newline at end of file diff --git a/api/GetItemUpdateLevel.lua b/api/GetItemUpdateLevel.lua new file mode 100644 index 0000000..3d99783 --- /dev/null +++ b/api/GetItemUpdateLevel.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number newItemLevel +---Returns an item's item level once it's been upgraded.. This function can currently only be called when at the upgrade merchant. +function GetItemUpdateLevel() end \ No newline at end of file diff --git a/api/GetItemUpgradeEffect.lua b/api/GetItemUpgradeEffect.lua new file mode 100644 index 0000000..32a6538 --- /dev/null +++ b/api/GetItemUpgradeEffect.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetItemUpgradeEffect() end \ No newline at end of file diff --git a/api/GetItemUpgradeItemInfo.lua b/api/GetItemUpgradeItemInfo.lua new file mode 100644 index 0000000..2b4011b --- /dev/null +++ b/api/GetItemUpgradeItemInfo.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string icon +---@return string name +---@return number quality +---@return string bound +---@return number numCurrUpgrades +---@return number numMaxUpgrades +---@return number cost +---@return number currencyType +---Returns information on the item that is currently being upgraded.. This function can currently only be called when at the upgrade merchant. +function GetItemUpgradeItemInfo() end \ No newline at end of file diff --git a/api/GetItemUpgradeStats.lua b/api/GetItemUpgradeStats.lua new file mode 100644 index 0000000..fdf0c8a --- /dev/null +++ b/api/GetItemUpgradeStats.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param getNew boolean +---@return string stat +---@return number amount +---@return string ... +---Returns stat names and amounts of original or upgraded item. This function can currently only be called when at the upgrade merchant +function GetItemUpgradeStats(getNew) end \ No newline at end of file diff --git a/api/GetLFDChoiceCollapseState.lua b/api/GetLFDChoiceCollapseState.lua new file mode 100644 index 0000000..f4bcc57 --- /dev/null +++ b/api/GetLFDChoiceCollapseState.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFDChoiceCollapseState() end \ No newline at end of file diff --git a/api/GetLFDChoiceEnabledState.lua b/api/GetLFDChoiceEnabledState.lua new file mode 100644 index 0000000..73f8065 --- /dev/null +++ b/api/GetLFDChoiceEnabledState.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFDChoiceEnabledState() end \ No newline at end of file diff --git a/api/GetLFDChoiceLockedState.lua b/api/GetLFDChoiceLockedState.lua new file mode 100644 index 0000000..dfa9aaf --- /dev/null +++ b/api/GetLFDChoiceLockedState.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFDChoiceLockedState() end \ No newline at end of file diff --git a/api/GetLFDChoiceOrder.lua b/api/GetLFDChoiceOrder.lua new file mode 100644 index 0000000..8859e04 --- /dev/null +++ b/api/GetLFDChoiceOrder.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFDChoiceOrder() end \ No newline at end of file diff --git a/api/GetLFDLockInfo.lua b/api/GetLFDLockInfo.lua new file mode 100644 index 0000000..22f952c --- /dev/null +++ b/api/GetLFDLockInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFDLockInfo() end \ No newline at end of file diff --git a/api/GetLFDLockPlayerCount.lua b/api/GetLFDLockPlayerCount.lua new file mode 100644 index 0000000..e2d1e83 --- /dev/null +++ b/api/GetLFDLockPlayerCount.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFDLockPlayerCount() end \ No newline at end of file diff --git a/api/GetLFDRoleLockInfo.lua b/api/GetLFDRoleLockInfo.lua new file mode 100644 index 0000000..bf850f5 --- /dev/null +++ b/api/GetLFDRoleLockInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFDRoleLockInfo() end \ No newline at end of file diff --git a/api/GetLFDRoleRestrictions.lua b/api/GetLFDRoleRestrictions.lua new file mode 100644 index 0000000..df4e562 --- /dev/null +++ b/api/GetLFDRoleRestrictions.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFDRoleRestrictions() end \ No newline at end of file diff --git a/api/GetLFGBonusFactionID.lua b/api/GetLFGBonusFactionID.lua new file mode 100644 index 0000000..9ec6d8f --- /dev/null +++ b/api/GetLFGBonusFactionID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFGBonusFactionID() end \ No newline at end of file diff --git a/api/GetLFGBootProposal.lua b/api/GetLFGBootProposal.lua new file mode 100644 index 0000000..2b6d0ac --- /dev/null +++ b/api/GetLFGBootProposal.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFGBootProposal() end \ No newline at end of file diff --git a/api/GetLFGCategoryForID.lua b/api/GetLFGCategoryForID.lua new file mode 100644 index 0000000..7fe6e33 --- /dev/null +++ b/api/GetLFGCategoryForID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFGCategoryForID() end \ No newline at end of file diff --git a/api/GetLFGCompletionReward.lua b/api/GetLFGCompletionReward.lua new file mode 100644 index 0000000..cd411a8 --- /dev/null +++ b/api/GetLFGCompletionReward.lua @@ -0,0 +1,13 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string name +---@return number typeID +---@return string textureFilename +---@return number moneyBase +---@return number moneyVar +---@return number experienceBase +---@return number experienceVar +---@return number numStrangers +---@return number numRewards +---Returns the various rewards for a completed LFG dungeon +function GetLFGCompletionReward() end \ No newline at end of file diff --git a/api/GetLFGCompletionRewardItem.lua b/api/GetLFGCompletionRewardItem.lua new file mode 100644 index 0000000..bac2077 --- /dev/null +++ b/api/GetLFGCompletionRewardItem.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFGCompletionRewardItem() end \ No newline at end of file diff --git a/api/GetLFGDeserterExpiration.lua b/api/GetLFGDeserterExpiration.lua new file mode 100644 index 0000000..77a7522 --- /dev/null +++ b/api/GetLFGDeserterExpiration.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFGDeserterExpiration() end \ No newline at end of file diff --git a/api/GetLFGDungeonEncounterInfo.lua b/api/GetLFGDungeonEncounterInfo.lua new file mode 100644 index 0000000..f95b270 --- /dev/null +++ b/api/GetLFGDungeonEncounterInfo.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param dungeonId number +---@param encounterIndex number +---@return string bossName +---@return nil texture +---@return boolean isKilled +---@return boolean result4 +---Returns whether an LFR encounter was already killed.. Does only give usable results for the encounters in the LFR part specified by the id +function GetLFGDungeonEncounterInfo(dungeonId, encounterIndex) end \ No newline at end of file diff --git a/api/GetLFGDungeonInfo.lua b/api/GetLFGDungeonInfo.lua new file mode 100644 index 0000000..eb4b025 --- /dev/null +++ b/api/GetLFGDungeonInfo.lua @@ -0,0 +1,19 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id integer +---@return string dungeonName +---@return integer typeId +---@return integer minLvl +---@return integer maxLvl +---@return integer recLvl +---@return integer minRecLvl +---@return integer maxRecLvl +---@return integer expansionId +---@return integer groupId +---@return string textureName +---@return integer difficulty +---@return integer maxPlayers +---@return string dungeonDesc +---@return boolean isHoliday +---Retrieves specific LFD information, not limited by player level and all dungeons can be looked up. +function GetLFGDungeonInfo(id) end \ No newline at end of file diff --git a/api/GetLFGDungeonNumEncounters.lua b/api/GetLFGDungeonNumEncounters.lua new file mode 100644 index 0000000..dd0b8c9 --- /dev/null +++ b/api/GetLFGDungeonNumEncounters.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param dungeonId number +---@return number totalEncounters +---@return number encountersCompleted +---Returns the number of encounters. +function GetLFGDungeonNumEncounters(dungeonId) end \ No newline at end of file diff --git a/api/GetLFGDungeonRewardCapBarInfo.lua b/api/GetLFGDungeonRewardCapBarInfo.lua new file mode 100644 index 0000000..45c004e --- /dev/null +++ b/api/GetLFGDungeonRewardCapBarInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFGDungeonRewardCapBarInfo() end \ No newline at end of file diff --git a/api/GetLFGDungeonRewardCapInfo.lua b/api/GetLFGDungeonRewardCapInfo.lua new file mode 100644 index 0000000..54d278f --- /dev/null +++ b/api/GetLFGDungeonRewardCapInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFGDungeonRewardCapInfo() end \ No newline at end of file diff --git a/api/GetLFGDungeonRewardInfo.lua b/api/GetLFGDungeonRewardInfo.lua new file mode 100644 index 0000000..e21405a --- /dev/null +++ b/api/GetLFGDungeonRewardInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFGDungeonRewardInfo() end \ No newline at end of file diff --git a/api/GetLFGDungeonRewardLink.lua b/api/GetLFGDungeonRewardLink.lua new file mode 100644 index 0000000..c5a04ee --- /dev/null +++ b/api/GetLFGDungeonRewardLink.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFGDungeonRewardLink() end \ No newline at end of file diff --git a/api/GetLFGDungeonRewards.lua b/api/GetLFGDungeonRewards.lua new file mode 100644 index 0000000..78cdf25 --- /dev/null +++ b/api/GetLFGDungeonRewards.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFGDungeonRewards() end \ No newline at end of file diff --git a/api/GetLFGDungeonShortageRewardInfo.lua b/api/GetLFGDungeonShortageRewardInfo.lua new file mode 100644 index 0000000..98c2495 --- /dev/null +++ b/api/GetLFGDungeonShortageRewardInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFGDungeonShortageRewardInfo() end \ No newline at end of file diff --git a/api/GetLFGDungeonShortageRewardLink.lua b/api/GetLFGDungeonShortageRewardLink.lua new file mode 100644 index 0000000..0214521 --- /dev/null +++ b/api/GetLFGDungeonShortageRewardLink.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFGDungeonShortageRewardLink() end \ No newline at end of file diff --git a/api/GetLFGInfoServer.lua b/api/GetLFGInfoServer.lua new file mode 100644 index 0000000..c2738c7 --- /dev/null +++ b/api/GetLFGInfoServer.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFGInfoServer() end \ No newline at end of file diff --git a/api/GetLFGInviteRoleAvailability.lua b/api/GetLFGInviteRoleAvailability.lua new file mode 100644 index 0000000..3144d94 --- /dev/null +++ b/api/GetLFGInviteRoleAvailability.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFGInviteRoleAvailability() end \ No newline at end of file diff --git a/api/GetLFGInviteRoleRestrictions.lua b/api/GetLFGInviteRoleRestrictions.lua new file mode 100644 index 0000000..38919b4 --- /dev/null +++ b/api/GetLFGInviteRoleRestrictions.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFGInviteRoleRestrictions() end \ No newline at end of file diff --git a/api/GetLFGMode.lua b/api/GetLFGMode.lua new file mode 100644 index 0000000..cd0b697 --- /dev/null +++ b/api/GetLFGMode.lua @@ -0,0 +1,15 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return rolecheck mode +---@return abandonedInDungeon +---@return lfgparty +---@return nil +---@return proposal +---@return queued +---@return rolecheck +---@return unempowered submode +---@return empowered +---@return nil +---@return unempowered +---Provides information about the LFG status of the player. +function GetLFGMode() end \ No newline at end of file diff --git a/api/GetLFGProposal.lua b/api/GetLFGProposal.lua new file mode 100644 index 0000000..e5c16a1 --- /dev/null +++ b/api/GetLFGProposal.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Returns info about the currently pending LFD operation +function GetLFGProposal() end \ No newline at end of file diff --git a/api/GetLFGProposalEncounter.lua b/api/GetLFGProposalEncounter.lua new file mode 100644 index 0000000..74a18ab --- /dev/null +++ b/api/GetLFGProposalEncounter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFGProposalEncounter() end \ No newline at end of file diff --git a/api/GetLFGProposalMember.lua b/api/GetLFGProposalMember.lua new file mode 100644 index 0000000..78c25a2 --- /dev/null +++ b/api/GetLFGProposalMember.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFGProposalMember() end \ No newline at end of file diff --git a/api/GetLFGQueueStats.lua b/api/GetLFGQueueStats.lua new file mode 100644 index 0000000..a30b790 --- /dev/null +++ b/api/GetLFGQueueStats.lua @@ -0,0 +1,21 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean hasData +---@return number leaderNeeds +---@return number tankNeeds +---@return number healerNeeds +---@return number dpsNeeds +---@return number totalTanks +---@return number totalHealers +---@return number totalDPS +---@return number instanceType +---@return number instanceSubType +---@return string instanceName +---@return number averageWait +---@return number tankWait +---@return number healerWait +---@return number dpsWait +---@return number myWait +---@return number queuedTime +---Returns information about a LFD queue when you are in the queue +function GetLFGQueueStats() end \ No newline at end of file diff --git a/api/GetLFGQueuedList.lua b/api/GetLFGQueuedList.lua new file mode 100644 index 0000000..f98ebde --- /dev/null +++ b/api/GetLFGQueuedList.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFGQueuedList() end \ No newline at end of file diff --git a/api/GetLFGRandomCooldownExpiration.lua b/api/GetLFGRandomCooldownExpiration.lua new file mode 100644 index 0000000..d60c2dc --- /dev/null +++ b/api/GetLFGRandomCooldownExpiration.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFGRandomCooldownExpiration() end \ No newline at end of file diff --git a/api/GetLFGRandomDungeonInfo.lua b/api/GetLFGRandomDungeonInfo.lua new file mode 100644 index 0000000..22ff80c --- /dev/null +++ b/api/GetLFGRandomDungeonInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFGRandomDungeonInfo() end \ No newline at end of file diff --git a/api/GetLFGRoleShortageRewards.lua b/api/GetLFGRoleShortageRewards.lua new file mode 100644 index 0000000..f97ff57 --- /dev/null +++ b/api/GetLFGRoleShortageRewards.lua @@ -0,0 +1,16 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param dungeonID number +---@param shortageIndex LFG_ROLE_SHORTAGE_UNCOMMON +---@param LFG_ROLE_SHORTAGE_PLENTIFUL +---@param LFG_ROLE_SHORTAGE_RARE +---@param LFG_ROLE_SHORTAGE_UNCOMMON +---@return boolean eligible +---@return boolean forTank +---@return boolean forHealer +---@return boolean forDamage +---@return number itemCount +---@return number money +---@return number xp +---Return information concerning the LFG Call to Arms rewards +function GetLFGRoleShortageRewards(dungeonID, shortageIndex, LFG_ROLE_SHORTAGE_PLENTIFUL, LFG_ROLE_SHORTAGE_RARE, LFG_ROLE_SHORTAGE_UNCOMMON) end \ No newline at end of file diff --git a/api/GetLFGRoleUpdate.lua b/api/GetLFGRoleUpdate.lua new file mode 100644 index 0000000..fbdd79d --- /dev/null +++ b/api/GetLFGRoleUpdate.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFGRoleUpdate() end \ No newline at end of file diff --git a/api/GetLFGRoleUpdateBattlegroundInfo.lua b/api/GetLFGRoleUpdateBattlegroundInfo.lua new file mode 100644 index 0000000..4a2ef1f --- /dev/null +++ b/api/GetLFGRoleUpdateBattlegroundInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFGRoleUpdateBattlegroundInfo() end \ No newline at end of file diff --git a/api/GetLFGRoleUpdateMember.lua b/api/GetLFGRoleUpdateMember.lua new file mode 100644 index 0000000..4c70fc0 --- /dev/null +++ b/api/GetLFGRoleUpdateMember.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFGRoleUpdateMember() end \ No newline at end of file diff --git a/api/GetLFGRoleUpdateSlot.lua b/api/GetLFGRoleUpdateSlot.lua new file mode 100644 index 0000000..16d6884 --- /dev/null +++ b/api/GetLFGRoleUpdateSlot.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFGRoleUpdateSlot() end \ No newline at end of file diff --git a/api/GetLFGRoles.lua b/api/GetLFGRoles.lua new file mode 100644 index 0000000..1bd87fb --- /dev/null +++ b/api/GetLFGRoles.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean leader +---@return boolean tank +---@return boolean healer +---@return boolean damage +---Returns the group roles for which the player has signed up in the LFG system +function GetLFGRoles() end \ No newline at end of file diff --git a/api/GetLFGSuspendedPlayers.lua b/api/GetLFGSuspendedPlayers.lua new file mode 100644 index 0000000..3a697e5 --- /dev/null +++ b/api/GetLFGSuspendedPlayers.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFGSuspendedPlayers() end \ No newline at end of file diff --git a/api/GetLFGTypes.lua b/api/GetLFGTypes.lua new file mode 100644 index 0000000..6621341 --- /dev/null +++ b/api/GetLFGTypes.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return list ... +---Returns a list of LFG query types +function GetLFGTypes() end \ No newline at end of file diff --git a/api/GetLFRChoiceOrder.lua b/api/GetLFRChoiceOrder.lua new file mode 100644 index 0000000..fffdb3f --- /dev/null +++ b/api/GetLFRChoiceOrder.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLFRChoiceOrder() end \ No newline at end of file diff --git a/api/GetLanguageByIndex.lua b/api/GetLanguageByIndex.lua new file mode 100644 index 0000000..29cf9d9 --- /dev/null +++ b/api/GetLanguageByIndex.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string languageName +---@return number languageIndex +---Returns the localized name of a player character language +function GetLanguageByIndex(index) end \ No newline at end of file diff --git a/api/GetLatestCompletedAchievements.lua b/api/GetLatestCompletedAchievements.lua new file mode 100644 index 0000000..9713868 --- /dev/null +++ b/api/GetLatestCompletedAchievements.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param isGuild boolean +---@return list ... +---Returns a list of the player's/player guild's most recently earned achievements +function GetLatestCompletedAchievements(isGuild) end \ No newline at end of file diff --git a/api/GetLatestCompletedComparisonAchievements.lua b/api/GetLatestCompletedComparisonAchievements.lua new file mode 100644 index 0000000..7a2f320 --- /dev/null +++ b/api/GetLatestCompletedComparisonAchievements.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return list ... +---Returns a list of the comparison unit's most recently earned achievements +function GetLatestCompletedComparisonAchievements() end \ No newline at end of file diff --git a/api/GetLatestThreeSenders.lua b/api/GetLatestThreeSenders.lua new file mode 100644 index 0000000..c31828e --- /dev/null +++ b/api/GetLatestThreeSenders.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string sender1 +---@return string sender2 +---@return string sender3 +---Returns the names of the last three senders of new mail. Returns sender names for new messages which the player has not yet seen in the mailbox; returns nothing if the player's inbox only contains unread messages which have been seen in the mailbox listing but not yet opened. +function GetLatestThreeSenders() end \ No newline at end of file diff --git a/api/GetLatestUpdatedComparisonStats.lua b/api/GetLatestUpdatedComparisonStats.lua new file mode 100644 index 0000000..f692669 --- /dev/null +++ b/api/GetLatestUpdatedComparisonStats.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return list ... +---Returns a list of the comparison unit's latest updated statistics.   Currently always returns a list of invalid statistic IDs -- the "latest updated statistics" feature is no longer a part of the Achievements UI. +function GetLatestUpdatedComparisonStats() end \ No newline at end of file diff --git a/api/GetLatestUpdatedStats.lua b/api/GetLatestUpdatedStats.lua new file mode 100644 index 0000000..2989600 --- /dev/null +++ b/api/GetLatestUpdatedStats.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return list ... +---Returns a list of the player's latest updated statistics. Currently always returns a list of invalid statistic IDs -- the "latest updated statistics" feature is no longer a part of the Achievements UI. +function GetLatestUpdatedStats() end \ No newline at end of file diff --git a/api/GetLegacyRaidDifficultyID.lua b/api/GetLegacyRaidDifficultyID.lua new file mode 100644 index 0000000..7c41856 --- /dev/null +++ b/api/GetLegacyRaidDifficultyID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLegacyRaidDifficultyID() end \ No newline at end of file diff --git a/api/GetLevelUpInstances.lua b/api/GetLevelUpInstances.lua new file mode 100644 index 0000000..86f5cc9 --- /dev/null +++ b/api/GetLevelUpInstances.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLevelUpInstances() end \ No newline at end of file diff --git a/api/GetLifesteal.lua b/api/GetLifesteal.lua new file mode 100644 index 0000000..98b2d23 --- /dev/null +++ b/api/GetLifesteal.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLifesteal() end \ No newline at end of file diff --git a/api/GetLocale.lua b/api/GetLocale.lua new file mode 100644 index 0000000..78a109d --- /dev/null +++ b/api/GetLocale.lua @@ -0,0 +1,15 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return zhTW locale +---@return deDE +---@return enGB +---@return enUS +---@return esES +---@return esMX +---@return frFR +---@return koKR +---@return ruRU +---@return zhCN +---@return zhTW +---Returns a code indicating the localization currently in use by the client +function GetLocale() end \ No newline at end of file diff --git a/api/GetLookingForGuildComment.lua b/api/GetLookingForGuildComment.lua new file mode 100644 index 0000000..66ea369 --- /dev/null +++ b/api/GetLookingForGuildComment.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLookingForGuildComment() end \ No newline at end of file diff --git a/api/GetLookingForGuildSettings.lua b/api/GetLookingForGuildSettings.lua new file mode 100644 index 0000000..16bb132 --- /dev/null +++ b/api/GetLookingForGuildSettings.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLookingForGuildSettings() end \ No newline at end of file diff --git a/api/GetLooseMacroIcons.lua b/api/GetLooseMacroIcons.lua new file mode 100644 index 0000000..6ac3dcf --- /dev/null +++ b/api/GetLooseMacroIcons.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLooseMacroIcons() end \ No newline at end of file diff --git a/api/GetLooseMacroItemIcons.lua b/api/GetLooseMacroItemIcons.lua new file mode 100644 index 0000000..49ad8a9 --- /dev/null +++ b/api/GetLooseMacroItemIcons.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetLooseMacroItemIcons() end \ No newline at end of file diff --git a/api/GetLootInfo.lua b/api/GetLootInfo.lua new file mode 100644 index 0000000..f9bf406 --- /dev/null +++ b/api/GetLootInfo.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@class LootInfo +---@field isQuestItem boolean? +---@field item string Item name +---@field locked boolean Can loot? +---@field quality number Item quality +---@field quantity number Item quantity +---@field roll boolean +---@field texture number Texture file ID + +function GetLootInfo() end \ No newline at end of file diff --git a/api/GetLootMethod.lua b/api/GetLootMethod.lua new file mode 100644 index 0000000..2e1eb51 --- /dev/null +++ b/api/GetLootMethod.lua @@ -0,0 +1,13 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return roundrobin method +---@return freeforall +---@return group +---@return master +---@return needbeforegreed +---@return personalloot +---@return roundrobin +---@return number partyMaster +---@return number raidMaster +---Returns information about the current loot method in a party or raid. Only returns useful information if the player is in a party or raid. +function GetLootMethod() end \ No newline at end of file diff --git a/api/GetLootRollItemInfo.lua b/api/GetLootRollItemInfo.lua new file mode 100644 index 0000000..43837f8 --- /dev/null +++ b/api/GetLootRollItemInfo.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@return string texture +---@return string name +---@return number count +---@return number quality +---@return 1nil bindOnPickUp +---Returns information about an item currently up for loot rolling +function GetLootRollItemInfo(id) end \ No newline at end of file diff --git a/api/GetLootRollItemLink.lua b/api/GetLootRollItemLink.lua new file mode 100644 index 0000000..f2d92f0 --- /dev/null +++ b/api/GetLootRollItemLink.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@return string link +---Returns a hyperlink for an item currently up for loot rolling +function GetLootRollItemLink(id) end \ No newline at end of file diff --git a/api/GetLootRollTimeLeft.lua b/api/GetLootRollTimeLeft.lua new file mode 100644 index 0000000..78cf665 --- /dev/null +++ b/api/GetLootRollTimeLeft.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@return number timeLeft +---Returns the amount of time remaining before loot rolling for an item expires. When the time expires, all group members who have not yet chosen to roll Need or Greed automatically pass, random roll results are produced for those who chose to roll, and the server declares a winner and awards the item. +function GetLootRollTimeLeft(id) end \ No newline at end of file diff --git a/api/GetLootSlotInfo.lua b/api/GetLootSlotInfo.lua new file mode 100644 index 0000000..fe9270b --- /dev/null +++ b/api/GetLootSlotInfo.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return string texture +---@return string item +---@return number quantity +---@return number quality +---@return 1nil locked +---Returns information about an item available as loot +function GetLootSlotInfo(slot) end \ No newline at end of file diff --git a/api/GetLootSlotLink.lua b/api/GetLootSlotLink.lua new file mode 100644 index 0000000..ff0fc8e --- /dev/null +++ b/api/GetLootSlotLink.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return string link +---Returns a hyperlink for an item available as loot. Returns nil if the loot slot is empty or contains money. +function GetLootSlotLink(slot) end \ No newline at end of file diff --git a/api/GetLootSlotType.lua b/api/GetLootSlotType.lua new file mode 100644 index 0000000..5d96968 --- /dev/null +++ b/api/GetLootSlotType.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return number loottype +---Returns the type of a given loot slot +function GetLootSlotType(slot) end \ No newline at end of file diff --git a/api/GetLootSourceInfo.lua b/api/GetLootSourceInfo.lua new file mode 100644 index 0000000..bdfccd6 --- /dev/null +++ b/api/GetLootSourceInfo.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string corpseGUID1 +---@return number count1 +---@return string corpseGUID2 +---@return number count2 +---@return ... +---Retreives information about a loot from multiple corpses (loot window must be opened) +function GetLootSourceInfo(index) end \ No newline at end of file diff --git a/api/GetLootSpecialization.lua b/api/GetLootSpecialization.lua new file mode 100644 index 0000000..128db59 --- /dev/null +++ b/api/GetLootSpecialization.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number specID +---Returns the specialization ID for the current loot specialization. This method returns 0 if the current loot specialization is set to "Current Specialization". Otherwise the global specialization ID will be returned. +function GetLootSpecialization() end \ No newline at end of file diff --git a/api/GetLootThreshold.lua b/api/GetLootThreshold.lua new file mode 100644 index 0000000..335a1e9 --- /dev/null +++ b/api/GetLootThreshold.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number threshold +---Returns the threshold used for Master Looter, Group Loot, and Need Before Greed loot methods. Items above the threshold quality will trigger the special behavior of the current loot method: for Group Loot and Need Before Greed, rolling will automatically begin once a group member loots the corpse or object holding the item; for Master Loot, the item will be invisible to all but the loot master tasked with assigning the loot. +function GetLootThreshold() end \ No newline at end of file diff --git a/api/GetMacroBody.lua b/api/GetMacroBody.lua new file mode 100644 index 0000000..2168d72 --- /dev/null +++ b/api/GetMacroBody.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param name string +---@return string body +---Returns the body text of a macro +function GetMacroBody(index, name) end \ No newline at end of file diff --git a/api/GetMacroIcons.lua b/api/GetMacroIcons.lua new file mode 100644 index 0000000..1e15b64 --- /dev/null +++ b/api/GetMacroIcons.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param tbl table +---@return table icons +---Returns a list of the available spell icon filenames for use in macros. The entries in this table are in 'array' form, beginning at index 1, so you can take the length of the list to get the number of available icons. In order to load item icons, you must also use GetMacroItemIcons, passing it the same table. These filenames are not usable directly, they must be prefixed with "INTERFACE\\ICONS\\" in order to be used. +function GetMacroIcons(tbl) end \ No newline at end of file diff --git a/api/GetMacroIndexByName.lua b/api/GetMacroIndexByName.lua new file mode 100644 index 0000000..7d7e345 --- /dev/null +++ b/api/GetMacroIndexByName.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@return number index +---Returns the index of a macro specified by name +function GetMacroIndexByName(name) end \ No newline at end of file diff --git a/api/GetMacroInfo.lua b/api/GetMacroInfo.lua new file mode 100644 index 0000000..f2b3e51 --- /dev/null +++ b/api/GetMacroInfo.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param name string +---@return string name +---@return string texture +---@return string body +---Returns information about a macro +function GetMacroInfo(index, name) end \ No newline at end of file diff --git a/api/GetMacroItem.lua b/api/GetMacroItem.lua new file mode 100644 index 0000000..ed7d227 --- /dev/null +++ b/api/GetMacroItem.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param name string +---@return string name +---@return string link +---Returns information about the item used by a macro. If a macro contains conditional, random, or sequence commands, this function returns the item which would currently be used if the macro were run. +function GetMacroItem(index, name) end \ No newline at end of file diff --git a/api/GetMacroItemIcons.lua b/api/GetMacroItemIcons.lua new file mode 100644 index 0000000..78559e8 --- /dev/null +++ b/api/GetMacroItemIcons.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param tbl table +---@return table icons +---Returns a list of the available item icon filenames for use in macros. The entries in this table are in 'array' form, beginning at index 1, so you can take the length of the list to get the number of available icons. In order to load item icons, you must also use GetMacroIcons, passing it the same table. These filenames are not usable directly, they must be prefixed with "INTERFACE\\ICONS\\" in order to be used. +function GetMacroItemIcons(tbl) end \ No newline at end of file diff --git a/api/GetMacroSpell.lua b/api/GetMacroSpell.lua new file mode 100644 index 0000000..2b87095 --- /dev/null +++ b/api/GetMacroSpell.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param name string +---@return string name +---@return string rank +---@return number spellID +---Returns information about the spell cast by a macro. If a macro contains conditional, random, or sequence commands, this function returns the spell which would currently be cast if the macro were run. +function GetMacroSpell(index, name) end \ No newline at end of file diff --git a/api/GetManaRegen.lua b/api/GetManaRegen.lua new file mode 100644 index 0000000..e0eaa9f --- /dev/null +++ b/api/GetManaRegen.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number base +---@return number casting +---Returns information about the player's mana regeneration rate +function GetManaRegen() end \ No newline at end of file diff --git a/api/GetMapContinents.lua b/api/GetMapContinents.lua new file mode 100644 index 0000000..c80484f --- /dev/null +++ b/api/GetMapContinents.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return list ... +---Returns a list of map continents names +function GetMapContinents() end \ No newline at end of file diff --git a/api/GetMapDebugObjectInfo.lua b/api/GetMapDebugObjectInfo.lua new file mode 100644 index 0000000..741042f --- /dev/null +++ b/api/GetMapDebugObjectInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetMapDebugObjectInfo() end \ No newline at end of file diff --git a/api/GetMapHierarchy.lua b/api/GetMapHierarchy.lua new file mode 100644 index 0000000..5088124 --- /dev/null +++ b/api/GetMapHierarchy.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetMapHierarchy() end \ No newline at end of file diff --git a/api/GetMapInfo.lua b/api/GetMapInfo.lua new file mode 100644 index 0000000..4a88c9e --- /dev/null +++ b/api/GetMapInfo.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string mapFileName +---@return number textureHeight +---@return string textureWidth +---@return boolean isMicroDungeon +---@return string microDungeonMapName +---Returns information about the current world map texture. World map images are broken into several tiles; the full texture paths follow the format "Interface\\WorldMap\\"..mapFileName.."\\"..mapFileName..i, where i is a number between 1 and 12 (or in a zone with multiple area images, "Interface\\WorldMap\\"..mapFileName.."\\"..mapFileName..dungeonLevel.."_"..i, where dungeonLevel is a number between 1 and GetNumDungeonMapLevels()). World map images are 4 tiles wide and 3 tiles high. +function GetMapInfo() end \ No newline at end of file diff --git a/api/GetMapLandmarkInfo.lua b/api/GetMapLandmarkInfo.lua new file mode 100644 index 0000000..8560076 --- /dev/null +++ b/api/GetMapLandmarkInfo.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---@return string description +---@return number textureIndex +---@return number x +---@return number y +---@return number mapLinkID +---@return boolean showInBattleMap +---Returns information about a map landmark. Possible landmarks include PvP objectives (both in battlegrounds and in world PvP areas), town and city markers on continent maps, and special markers such as those used during the Scourge Invasion world event. Some landmarks (such as those for towns on a zone map) exist but are not visible in the default UI. +function GetMapLandmarkInfo(index) end \ No newline at end of file diff --git a/api/GetMapNameByID.lua b/api/GetMapNameByID.lua new file mode 100644 index 0000000..b33b97b --- /dev/null +++ b/api/GetMapNameByID.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@return string mapname +---Returns the localized name of a given map. Map IDs can be obtained using GetCurrentMapAreaID(). Note that you cannot obtain names of multiple floors of a map using this function. Oddly enough, these are stored in global variables, as follows: local floorName = _G["DUNGEON_FLOOR_" .. strupper(GetMapInfo() or "") .. floorNum] +function GetMapNameByID(id) end \ No newline at end of file diff --git a/api/GetMapOverlayInfo.lua b/api/GetMapOverlayInfo.lua new file mode 100644 index 0000000..125085b --- /dev/null +++ b/api/GetMapOverlayInfo.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string textureName +---@return number textureWidth +---@return number textureHeight +---@return number offsetX +---@return number offsetY +---@return number mapPointX +---@return number mapPointY +---Returns information about a world map overlay. Map overlays correspond to areas which are "discovered" when entered by the player, "filling in" the blank areas of the world map. +function GetMapOverlayInfo(index) end \ No newline at end of file diff --git a/api/GetMapSubzones.lua b/api/GetMapSubzones.lua new file mode 100644 index 0000000..c6019b2 --- /dev/null +++ b/api/GetMapSubzones.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param zoneID number +---@return list zoneid1,zonename1, zoneid2,zonename2, zoneid3,zonename3... +---Returns the map subzones for a given zone +function GetMapSubzones(zoneID) end \ No newline at end of file diff --git a/api/GetMapZones.lua b/api/GetMapZones.lua new file mode 100644 index 0000000..dea81d3 --- /dev/null +++ b/api/GetMapZones.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param continentIndex number +---@return list ... +---Returns the map zones for a given continent +function GetMapZones(continentIndex) end \ No newline at end of file diff --git a/api/GetMasterLootCandidate.lua b/api/GetMasterLootCandidate.lua new file mode 100644 index 0000000..48e342c --- /dev/null +++ b/api/GetMasterLootCandidate.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string candidate +---Returns information about a given loot candidate. Used in the default UI to build the popup menu used in master loot assignment. Only valid if the player is the master looter. Not all party/raid members may be eligible for a given corpse's (or object's) loot: e.g. a member is ineligible for loot from a creature killed while that member was not in the immediate area. By repeatedly calling this function (with index incrementing from 1 to the total number of party/raid members, including the player), one can build a list of the names of members eligible for the current loot. The index is cast in stone at the time the mob was killed. If you move raid members around prior to distributing loot, their original positions will be returned by this function. The expression ceil(index/5) will yield the group number (in a raid) and the expression index % 5 will yield the group position number for an eligible raider. +function GetMasterLootCandidate(index) end \ No newline at end of file diff --git a/api/GetMastery.lua b/api/GetMastery.lua new file mode 100644 index 0000000..00d1a0b --- /dev/null +++ b/api/GetMastery.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Returns the mastery value of your character +function GetMastery() end \ No newline at end of file diff --git a/api/GetMasteryEffect.lua b/api/GetMasteryEffect.lua new file mode 100644 index 0000000..1babb92 --- /dev/null +++ b/api/GetMasteryEffect.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetMasteryEffect() end \ No newline at end of file diff --git a/api/GetMaxAnimFramerate.lua b/api/GetMaxAnimFramerate.lua new file mode 100644 index 0000000..81a0cbf --- /dev/null +++ b/api/GetMaxAnimFramerate.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetMaxAnimFramerate() end \ No newline at end of file diff --git a/api/GetMaxArenaCurrency.lua b/api/GetMaxArenaCurrency.lua new file mode 100644 index 0000000..ee99046 --- /dev/null +++ b/api/GetMaxArenaCurrency.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number amount +---Returns the maximum amount of arena points the player can accrue +function GetMaxArenaCurrency() end \ No newline at end of file diff --git a/api/GetMaxBattlefieldID.lua b/api/GetMaxBattlefieldID.lua new file mode 100644 index 0000000..78f3d8e --- /dev/null +++ b/api/GetMaxBattlefieldID.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numBattlefields +---Returns the number of battlefields the player is associated with.. GetBattlefieldStatus(index) can be used to retrieve detailed information about a battlefield. +function GetMaxBattlefieldID() end \ No newline at end of file diff --git a/api/GetMaxCombatRatingBonus.lua b/api/GetMaxCombatRatingBonus.lua new file mode 100644 index 0000000..bdc7931 --- /dev/null +++ b/api/GetMaxCombatRatingBonus.lua @@ -0,0 +1,29 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param ratingIndex CR_WEAPON_SKILL_RANGED +---@param CR_BLOCK +---@param CR_CRIT_MELEE +---@param CR_CRIT_RANGED +---@param CR_CRIT_SPELL +---@param CR_CRIT_TAKEN_MELEE +---@param CR_CRIT_TAKEN_RANGED +---@param CR_CRIT_TAKEN_SPELL +---@param CR_DEFENSE_SKILL +---@param CR_DODGE +---@param CR_HASTE_MELEE +---@param CR_HASTE_RANGED +---@param CR_HASTE_SPELL +---@param CR_HIT_MELEE +---@param CR_HIT_RANGED +---@param CR_HIT_SPELL +---@param CR_HIT_TAKEN_MELEE +---@param CR_HIT_TAKEN_RANGED +---@param CR_HIT_TAKEN_SPELL +---@param CR_PARRY +---@param CR_WEAPON_SKILL +---@param CR_WEAPON_SKILL_MAINHAND +---@param CR_WEAPON_SKILL_OFFHAND +---@param CR_WEAPON_SKILL_RANGED +---@return number max +---Returns the maximum possible percentage bonus for a given combat rating. While this function can be applied to all combat ratings, it is currently only used in the default UI to account for the cap on (incoming) critical strike damage and mana drains provided by Resilience rating -- specifically, in generating the tooltip where Resilience rating is shown in the Character window (PaperDollFrame). +function GetMaxCombatRatingBonus(ratingIndex, CR_BLOCK, CR_CRIT_MELEE, CR_CRIT_RANGED, CR_CRIT_SPELL, CR_CRIT_TAKEN_MELEE, CR_CRIT_TAKEN_RANGED, CR_CRIT_TAKEN_SPELL, CR_DEFENSE_SKILL, CR_DODGE, CR_HASTE_MELEE, CR_HASTE_RANGED, CR_HASTE_SPELL, CR_HIT_MELEE, CR_HIT_RANGED, CR_HIT_SPELL, CR_HIT_TAKEN_MELEE, CR_HIT_TAKEN_RANGED, CR_HIT_TAKEN_SPELL, CR_PARRY, CR_WEAPON_SKILL, CR_WEAPON_SKILL_MAINHAND, CR_WEAPON_SKILL_OFFHAND, CR_WEAPON_SKILL_RANGED) end \ No newline at end of file diff --git a/api/GetMaxPlayerLevel.lua b/api/GetMaxPlayerLevel.lua new file mode 100644 index 0000000..4397b6a --- /dev/null +++ b/api/GetMaxPlayerLevel.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number maxLevel +---Returns the maximum level attainable by a player +function GetMaxPlayerLevel() end \ No newline at end of file diff --git a/api/GetMaxRewardCurrencies.lua b/api/GetMaxRewardCurrencies.lua new file mode 100644 index 0000000..524b11d --- /dev/null +++ b/api/GetMaxRewardCurrencies.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetMaxRewardCurrencies() end \ No newline at end of file diff --git a/api/GetMaxSpellStartRecoveryOffset.lua b/api/GetMaxSpellStartRecoveryOffset.lua new file mode 100644 index 0000000..7e20e40 --- /dev/null +++ b/api/GetMaxSpellStartRecoveryOffset.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetMaxSpellStartRecoveryOffset() end \ No newline at end of file diff --git a/api/GetMaxTalentTier.lua b/api/GetMaxTalentTier.lua new file mode 100644 index 0000000..43a7121 --- /dev/null +++ b/api/GetMaxTalentTier.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetMaxTalentTier() end \ No newline at end of file diff --git a/api/GetMeleeHaste.lua b/api/GetMeleeHaste.lua new file mode 100644 index 0000000..18674ad --- /dev/null +++ b/api/GetMeleeHaste.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number haste +---Returns information about the player's melee haste +function GetMeleeHaste() end \ No newline at end of file diff --git a/api/GetMerchantCurrencies.lua b/api/GetMerchantCurrencies.lua new file mode 100644 index 0000000..c783497 --- /dev/null +++ b/api/GetMerchantCurrencies.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetMerchantCurrencies() end \ No newline at end of file diff --git a/api/GetMerchantFilter.lua b/api/GetMerchantFilter.lua new file mode 100644 index 0000000..5c0aa70 --- /dev/null +++ b/api/GetMerchantFilter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Returns the index of the filter applied to the merchant. +function GetMerchantFilter() end \ No newline at end of file diff --git a/api/GetMerchantItemCostInfo.lua b/api/GetMerchantItemCostInfo.lua new file mode 100644 index 0000000..e316951 --- /dev/null +++ b/api/GetMerchantItemCostInfo.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number currencyCount +---Returns information about alternate currencies required to purchase an item from a vendor +function GetMerchantItemCostInfo(index) end \ No newline at end of file diff --git a/api/GetMerchantItemCostItem.lua b/api/GetMerchantItemCostItem.lua new file mode 100644 index 0000000..aca3da5 --- /dev/null +++ b/api/GetMerchantItemCostItem.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param currency number +---@return string texture +---@return number value +---@return string link +---@return string name +---Returns information about currency items required to purchase an item from a vendor +function GetMerchantItemCostItem(index, currency) end \ No newline at end of file diff --git a/api/GetMerchantItemInfo.lua b/api/GetMerchantItemInfo.lua new file mode 100644 index 0000000..52f6b4d --- /dev/null +++ b/api/GetMerchantItemInfo.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---@return string texture +---@return number price +---@return number quantity +---@return number numAvailable +---@return 1nil isUsable +---@return 1nil extendedCost +---Returns information about an item available for purchase from a vendor +function GetMerchantItemInfo(index) end \ No newline at end of file diff --git a/api/GetMerchantItemLink.lua b/api/GetMerchantItemLink.lua new file mode 100644 index 0000000..9494e99 --- /dev/null +++ b/api/GetMerchantItemLink.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string link +---Returns a hyperlink for an item available for purchase from a vendor +function GetMerchantItemLink(index) end \ No newline at end of file diff --git a/api/GetMerchantItemMaxStack.lua b/api/GetMerchantItemMaxStack.lua new file mode 100644 index 0000000..1cd1c0d --- /dev/null +++ b/api/GetMerchantItemMaxStack.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number maxStack +---Returns the maximum number of an item allowed in a single purchase. Determines the largest value usable for the second argument (quantity) of BuyMerchantItem() when purchasing the item. For most items, this is the same as the maximum stack size of the item. +function GetMerchantItemMaxStack(index) end \ No newline at end of file diff --git a/api/GetMerchantNumItems.lua b/api/GetMerchantNumItems.lua new file mode 100644 index 0000000..c6549b7 --- /dev/null +++ b/api/GetMerchantNumItems.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numMerchantItems +---Returns the number of different items available for purchase from a vendor +function GetMerchantNumItems() end \ No newline at end of file diff --git a/api/GetMinimapZoneText.lua b/api/GetMinimapZoneText.lua new file mode 100644 index 0000000..783d3f7 --- /dev/null +++ b/api/GetMinimapZoneText.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string zoneText +---Returns the name of the current area (as displayed in the Minimap). Matches GetSubZoneText(), GetRealZoneText() or GetZoneText(). +function GetMinimapZoneText() end \ No newline at end of file diff --git a/api/GetMirrorTimerInfo.lua b/api/GetMirrorTimerInfo.lua new file mode 100644 index 0000000..3ccbe22 --- /dev/null +++ b/api/GetMirrorTimerInfo.lua @@ -0,0 +1,15 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return FEIGNDEATH timer +---@return BREATH +---@return DEATH +---@return EXHAUSTION +---@return FEIGNDEATH +---@return number value +---@return number maxvalue +---@return number scale +---@return number paused +---@return string label +---Returns information about special countdown timers +function GetMirrorTimerInfo(index) end \ No newline at end of file diff --git a/api/GetMirrorTimerProgress.lua b/api/GetMirrorTimerProgress.lua new file mode 100644 index 0000000..b4cb609 --- /dev/null +++ b/api/GetMirrorTimerProgress.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param timer FEIGNDEATH +---@param BREATH +---@param DEATH +---@param EXHAUSTION +---@param FEIGNDEATH +---@return number progress +---Returns a high-resolution value for a special countdown timer +function GetMirrorTimerProgress(timer, BREATH, DEATH, EXHAUSTION, FEIGNDEATH) end \ No newline at end of file diff --git a/api/GetMissingLootItemInfo.lua b/api/GetMissingLootItemInfo.lua new file mode 100644 index 0000000..0e5d959 --- /dev/null +++ b/api/GetMissingLootItemInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetMissingLootItemInfo() end \ No newline at end of file diff --git a/api/GetMissingLootItemLink.lua b/api/GetMissingLootItemLink.lua new file mode 100644 index 0000000..eccb1ea --- /dev/null +++ b/api/GetMissingLootItemLink.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetMissingLootItemLink() end \ No newline at end of file diff --git a/api/GetModResilienceDamageReduction.lua b/api/GetModResilienceDamageReduction.lua new file mode 100644 index 0000000..ed9d66a --- /dev/null +++ b/api/GetModResilienceDamageReduction.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetModResilienceDamageReduction() end \ No newline at end of file diff --git a/api/GetModifiedClick.lua b/api/GetModifiedClick.lua new file mode 100644 index 0000000..a35c73b --- /dev/null +++ b/api/GetModifiedClick.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@return string binding +---Returns the keys/buttons bound for a modified click action +function GetModifiedClick(name) end \ No newline at end of file diff --git a/api/GetModifiedClickAction.lua b/api/GetModifiedClickAction.lua new file mode 100644 index 0000000..2f80c41 --- /dev/null +++ b/api/GetModifiedClickAction.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string action +---Returns the token identifying a modified click action +function GetModifiedClickAction(index) end \ No newline at end of file diff --git a/api/GetMoney.lua b/api/GetMoney.lua new file mode 100644 index 0000000..cebc648 --- /dev/null +++ b/api/GetMoney.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number money +---Returns the total amount of money currently in the player's possession +function GetMoney() end \ No newline at end of file diff --git a/api/GetMonitorAspectRatio.lua b/api/GetMonitorAspectRatio.lua new file mode 100644 index 0000000..7ed96e9 --- /dev/null +++ b/api/GetMonitorAspectRatio.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param monitorIndex number +---@return number ratio +---Query a monitor's aspect ratio +function GetMonitorAspectRatio(monitorIndex) end \ No newline at end of file diff --git a/api/GetMonitorCount.lua b/api/GetMonitorCount.lua new file mode 100644 index 0000000..7078632 --- /dev/null +++ b/api/GetMonitorCount.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number count +---Returns the number of monitors connected +function GetMonitorCount() end \ No newline at end of file diff --git a/api/GetMonitorName.lua b/api/GetMonitorName.lua new file mode 100644 index 0000000..b50b035 --- /dev/null +++ b/api/GetMonitorName.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param monitorIndex number +---@return string name +---Returns the system name of a selected monitor +function GetMonitorName(monitorIndex) end \ No newline at end of file diff --git a/api/GetMouseButtonClicked.lua b/api/GetMouseButtonClicked.lua new file mode 100644 index 0000000..76f5047 --- /dev/null +++ b/api/GetMouseButtonClicked.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string button +---Returns which mouse button triggered the current script. If called in a line of execution that started with a click handler (OnMouseDown, OnMouseUp, OnClick, OnDoubleClick, PreClick, or PostClick), returns a string identifying which mouse button triggered the handler. Otherwise, returns nil. +function GetMouseButtonClicked() end \ No newline at end of file diff --git a/api/GetMouseButtonName.lua b/api/GetMouseButtonName.lua new file mode 100644 index 0000000..eaa5380 --- /dev/null +++ b/api/GetMouseButtonName.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param buttonNumber number +---@return RightButton buttonName +---@return Button4 +---@return Button5 +---@return LeftButton +---@return MiddleButton +---@return RightButton +---Returns the name for a mouse button specified by number +function GetMouseButtonName(buttonNumber) end \ No newline at end of file diff --git a/api/GetMouseFocus.lua b/api/GetMouseFocus.lua new file mode 100644 index 0000000..0bf4ced --- /dev/null +++ b/api/GetMouseFocus.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return table frame +---Returns the frame that is currently under the mouse, and has mouse input enabled. +function GetMouseFocus() end \ No newline at end of file diff --git a/api/GetMovieDownloadProgress.lua b/api/GetMovieDownloadProgress.lua new file mode 100644 index 0000000..3e60b8a --- /dev/null +++ b/api/GetMovieDownloadProgress.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetMovieDownloadProgress() end \ No newline at end of file diff --git a/api/GetMultiCastBarIndex.lua b/api/GetMultiCastBarIndex.lua new file mode 100644 index 0000000..930c01d --- /dev/null +++ b/api/GetMultiCastBarIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetMultiCastBarIndex() end \ No newline at end of file diff --git a/api/GetMultiCastTotemSpells.lua b/api/GetMultiCastTotemSpells.lua new file mode 100644 index 0000000..9f7259e --- /dev/null +++ b/api/GetMultiCastTotemSpells.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetMultiCastTotemSpells() end \ No newline at end of file diff --git a/api/GetMultistrike.lua b/api/GetMultistrike.lua new file mode 100644 index 0000000..8ffac82 --- /dev/null +++ b/api/GetMultistrike.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetMultistrike() end \ No newline at end of file diff --git a/api/GetMultistrikeEffect.lua b/api/GetMultistrikeEffect.lua new file mode 100644 index 0000000..905ce42 --- /dev/null +++ b/api/GetMultistrikeEffect.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetMultistrikeEffect() end \ No newline at end of file diff --git a/api/GetMuteName.lua b/api/GetMuteName.lua new file mode 100644 index 0000000..b34ed9a --- /dev/null +++ b/api/GetMuteName.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---Returns the name of a character on the mute list +function GetMuteName(index) end \ No newline at end of file diff --git a/api/GetMuteStatus.lua b/api/GetMuteStatus.lua new file mode 100644 index 0000000..e259598 --- /dev/null +++ b/api/GetMuteStatus.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@param channel string +---@return 1nil muteStatus +---Returns whether a character is muted or silenced. If the channel argument is specified, this function checks the given character's voice/silence status on the channel as well as for whether the character is on the player's Muted list. +function GetMuteStatus(unit, name, channel) end \ No newline at end of file diff --git a/api/GetNamePlateMotionType.lua b/api/GetNamePlateMotionType.lua new file mode 100644 index 0000000..ba27731 --- /dev/null +++ b/api/GetNamePlateMotionType.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNamePlateMotionType() end \ No newline at end of file diff --git a/api/GetNetIpTypes.lua b/api/GetNetIpTypes.lua new file mode 100644 index 0000000..ea7f1ec --- /dev/null +++ b/api/GetNetIpTypes.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNetIpTypes() end \ No newline at end of file diff --git a/api/GetNetStats.lua b/api/GetNetStats.lua new file mode 100644 index 0000000..879a49c --- /dev/null +++ b/api/GetNetStats.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number bandwidthIn +---@return number bandwidthOut +---@return number latencyHome +---@return number latencyWorld +---Returns information about current network connection performance +function GetNetStats() end \ No newline at end of file diff --git a/api/GetNewSocketInfo.lua b/api/GetNewSocketInfo.lua new file mode 100644 index 0000000..cbfc639 --- /dev/null +++ b/api/GetNewSocketInfo.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---@return string texture +---@return 1nil matches +---Returns information about a gem added to a socket. If the given socket contains a new gem (one that has been placed in the UI, but not yet confirmed for permanently socketing into the item), returns information for that gem. If the socket is empty or has a permanently socketed gem but no new gem, returns nil. Only returns valid information when the Item Socketing UI is open (i.e. between the SOCKET_INFO_UPDATE and SOCKET_INFO_CLOSE events). +function GetNewSocketInfo(index) end \ No newline at end of file diff --git a/api/GetNewSocketLink.lua b/api/GetNewSocketLink.lua new file mode 100644 index 0000000..eafc0aa --- /dev/null +++ b/api/GetNewSocketLink.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string link +---Returns a hyperlink for a gem added to a socket. If the given socket contains a new gem (one that has been placed in the UI, but not yet confirmed for permanently socketing into the item), returns an item link for that gem. If the socket is empty or has a permanently socketed gem but no new gem, returns nil. Only returns valid information when the Item Socketing UI is open (i.e. between the SOCKET_INFO_UPDATE and SOCKET_INFO_CLOSE events). +function GetNewSocketLink(index) end \ No newline at end of file diff --git a/api/GetNextAchievement.lua b/api/GetNextAchievement.lua new file mode 100644 index 0000000..8eefeb4 --- /dev/null +++ b/api/GetNextAchievement.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@return number nextID +---@return boolean completed +---Returns the next achievement for an achievement which is part of a series +function GetNextAchievement(id) end \ No newline at end of file diff --git a/api/GetNextCompleatedTutorial.lua b/api/GetNextCompleatedTutorial.lua new file mode 100644 index 0000000..addeb5d --- /dev/null +++ b/api/GetNextCompleatedTutorial.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNextCompleatedTutorial() end \ No newline at end of file diff --git a/api/GetNumActiveQuests.lua b/api/GetNumActiveQuests.lua new file mode 100644 index 0000000..2d3a75c --- /dev/null +++ b/api/GetNumActiveQuests.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numActiveQuests +---Returns the number of quests which can be turned in to the current Quest NPC. Only returns valid information after a QUEST_GREETING event. Note: Most quest NPCs present active quests using the GetGossipActiveQuests() instead of this function. +function GetNumActiveQuests() end \ No newline at end of file diff --git a/api/GetNumAddOns.lua b/api/GetNumAddOns.lua new file mode 100644 index 0000000..1e0aa67 --- /dev/null +++ b/api/GetNumAddOns.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numAddons +---Returns the number of addons in the addon listing +function GetNumAddOns() end \ No newline at end of file diff --git a/api/GetNumArchaeologyRaces.lua b/api/GetNumArchaeologyRaces.lua new file mode 100644 index 0000000..b5f340f --- /dev/null +++ b/api/GetNumArchaeologyRaces.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numRaces +---Return the number of different races (branches) in Archeology. As of the Warlords of Draenor expansion, these are the valid race IDs: Dwarf Draenei Fossil Night Elf Nerubian Orc Tol'vir Troll Vrykul Mantid Pandaren Mogu Arakkoa Draenor Clans Ogre +function GetNumArchaeologyRaces() end \ No newline at end of file diff --git a/api/GetNumArenaOpponentSpecs.lua b/api/GetNumArenaOpponentSpecs.lua new file mode 100644 index 0000000..fe5ecb0 --- /dev/null +++ b/api/GetNumArenaOpponentSpecs.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numOpps +---Returns the number of enemy players which specialization data are available in an arena match +function GetNumArenaOpponentSpecs() end \ No newline at end of file diff --git a/api/GetNumArenaOpponents.lua b/api/GetNumArenaOpponents.lua new file mode 100644 index 0000000..17e51af --- /dev/null +++ b/api/GetNumArenaOpponents.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numOpponents +---Returns the number of enemy players in an arena match +function GetNumArenaOpponents() end \ No newline at end of file diff --git a/api/GetNumArtifactsByRace.lua b/api/GetNumArtifactsByRace.lua new file mode 100644 index 0000000..a63c32c --- /dev/null +++ b/api/GetNumArtifactsByRace.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param branchID number +---@return number numProjects +---Return the amount of artifacts the player has acquired from the provided race. Opening the Archaeology window populates the values. The value returned is the number of completed artifacts for that race plus one for the in progress artifact. If the player hasn't collected the race's fragments yet, the value will be 0. Artifacts are only counted once so no matter how many times an artifact has been repeated it counts as one. +function GetNumArtifactsByRace(branchID) end \ No newline at end of file diff --git a/api/GetNumAuctionItems.lua b/api/GetNumAuctionItems.lua new file mode 100644 index 0000000..c5a5b9b --- /dev/null +++ b/api/GetNumAuctionItems.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param list owner +---@param bidder +---@param list +---@param owner +---@return number numBatchAuctions +---@return number totalAuctions +---Returns the number of auction items in a listing +function GetNumAuctionItems(list, bidder, list, owner) end \ No newline at end of file diff --git a/api/GetNumAutoQuestPopUps.lua b/api/GetNumAutoQuestPopUps.lua new file mode 100644 index 0000000..7b2f40b --- /dev/null +++ b/api/GetNumAutoQuestPopUps.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numPopups +---Returns number of AutoQuestPopup(s) +function GetNumAutoQuestPopUps() end \ No newline at end of file diff --git a/api/GetNumAvailableQuests.lua b/api/GetNumAvailableQuests.lua new file mode 100644 index 0000000..de94fd5 --- /dev/null +++ b/api/GetNumAvailableQuests.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numAvailableQuests +---Returns the number quests available from the current Quest NPC. Only returns valid information after a QUEST_GREETING event. Note: Most quest NPCs present available quests using the GetGossipAvailableQuests() instead of this function. +function GetNumAvailableQuests() end \ No newline at end of file diff --git a/api/GetNumBankSlots.lua b/api/GetNumBankSlots.lua new file mode 100644 index 0000000..0bd36dc --- /dev/null +++ b/api/GetNumBankSlots.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numSlots +---@return 1nil isFull +---Returns information about purchased bank bag slots +function GetNumBankSlots() end \ No newline at end of file diff --git a/api/GetNumBattlefieldFlagPositions.lua b/api/GetNumBattlefieldFlagPositions.lua new file mode 100644 index 0000000..22c36c7 --- /dev/null +++ b/api/GetNumBattlefieldFlagPositions.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numFlags +---Returns the number of battleground flags for which map position information is available +function GetNumBattlefieldFlagPositions() end \ No newline at end of file diff --git a/api/GetNumBattlefieldScores.lua b/api/GetNumBattlefieldScores.lua new file mode 100644 index 0000000..eb70cf4 --- /dev/null +++ b/api/GetNumBattlefieldScores.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numScores +---Returns the number of participant scores available in the current battleground +function GetNumBattlefieldScores() end \ No newline at end of file diff --git a/api/GetNumBattlefieldStats.lua b/api/GetNumBattlefieldStats.lua new file mode 100644 index 0000000..103b1ed --- /dev/null +++ b/api/GetNumBattlefieldStats.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numStats +---Returns the number of battleground-specific statistics on the current battleground's scoreboard. Battleground-specific statistics include flags captured in Warsong Gulch, towers assaulted in Alterac Valley, etc. For the name and icon associated with each statistic, see GetBattlefieldStatInfo(). +function GetNumBattlefieldStats() end \ No newline at end of file diff --git a/api/GetNumBattlefieldVehicles.lua b/api/GetNumBattlefieldVehicles.lua new file mode 100644 index 0000000..fc37696 --- /dev/null +++ b/api/GetNumBattlefieldVehicles.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numVehicles +---Returns the number of special vehicles in the current zone. Used only for certain vehicles in certain zones: includes the airships in Icecrown as well as vehicles used in Ulduar, Wintergrasp, and Strand of the Ancients. +function GetNumBattlefieldVehicles() end \ No newline at end of file diff --git a/api/GetNumBattlegroundTypes.lua b/api/GetNumBattlegroundTypes.lua new file mode 100644 index 0000000..291e7bb --- /dev/null +++ b/api/GetNumBattlegroundTypes.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numBattlegrounds +---Returns the number of different battlegrounds available. Refers to distinct battlegrounds, not battleground instances. Does not indicate the number of battlegrounds the player can enter: for that, see GetBattlegroundInfo. As of WoW 3.2, should always return 6: for Alterac Valley, Warsong Gulch, Arathi Basin, Eye of the Storm, Strand of the Ancients, and Isle of Conquest. If a future patch adds a new battleground, this function will reflect that. +function GetNumBattlegroundTypes() end \ No newline at end of file diff --git a/api/GetNumBindings.lua b/api/GetNumBindings.lua new file mode 100644 index 0000000..caace8e --- /dev/null +++ b/api/GetNumBindings.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numBindings +---Returns the number of entries in the key bindings list +function GetNumBindings() end \ No newline at end of file diff --git a/api/GetNumBuybackItems.lua b/api/GetNumBuybackItems.lua new file mode 100644 index 0000000..f106a65 --- /dev/null +++ b/api/GetNumBuybackItems.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numBuybackItems +---Returns the number of items recently sold to a vendor and available to be repurchased +function GetNumBuybackItems() end \ No newline at end of file diff --git a/api/GetNumChallengeMapRewards.lua b/api/GetNumChallengeMapRewards.lua new file mode 100644 index 0000000..5390e3d --- /dev/null +++ b/api/GetNumChallengeMapRewards.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumChallengeMapRewards() end \ No newline at end of file diff --git a/api/GetNumChallengeModeLeaders.lua b/api/GetNumChallengeModeLeaders.lua new file mode 100644 index 0000000..5d5babc --- /dev/null +++ b/api/GetNumChallengeModeLeaders.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumChallengeModeLeaders() end \ No newline at end of file diff --git a/api/GetNumChannelMembers.lua b/api/GetNumChannelMembers.lua new file mode 100644 index 0000000..7c8b898 --- /dev/null +++ b/api/GetNumChannelMembers.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@return number numMembers +---Returns the number of members in a chat channel +function GetNumChannelMembers(id) end \ No newline at end of file diff --git a/api/GetNumClasses.lua b/api/GetNumClasses.lua new file mode 100644 index 0000000..bb757af --- /dev/null +++ b/api/GetNumClasses.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumClasses() end \ No newline at end of file diff --git a/api/GetNumCompanions.lua b/api/GetNumCompanions.lua new file mode 100644 index 0000000..e1292b8 --- /dev/null +++ b/api/GetNumCompanions.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param type MOUNT +---@param CRITTER +---@param MOUNT +---@return number count +---Returns the number of mounts or non-combat pets the player can summon +function GetNumCompanions(type, CRITTER, MOUNT) end \ No newline at end of file diff --git a/api/GetNumComparisonCompletedAchievements.lua b/api/GetNumComparisonCompletedAchievements.lua new file mode 100644 index 0000000..42ace33 --- /dev/null +++ b/api/GetNumComparisonCompletedAchievements.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number total +---@return number completed +---Returns the number of achievements earned by the comparison unit.   Does not include Feats of Strength. +function GetNumComparisonCompletedAchievements() end \ No newline at end of file diff --git a/api/GetNumCompletedAchievements.lua b/api/GetNumCompletedAchievements.lua new file mode 100644 index 0000000..4ca91d1 --- /dev/null +++ b/api/GetNumCompletedAchievements.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param isForGuild boolean +---@return number total +---@return number completed +---Returns the number of achievements earned by the player/guild. Does not include Feats of Strength. +function GetNumCompletedAchievements(isForGuild) end \ No newline at end of file diff --git a/api/GetNumDeclensionSets.lua b/api/GetNumDeclensionSets.lua new file mode 100644 index 0000000..a515979 --- /dev/null +++ b/api/GetNumDeclensionSets.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param gender 3 +---@param 1 or nil +---@param 2 +---@param 3 +---@return number numSets +---Returns the number of suggested declension sets for a name. Used in the Russian localized World of Warcraft client; see DeclineName for further details. Returns 0 in other locales. +function GetNumDeclensionSets(name, gender, 1 or nil, 2, 3) end \ No newline at end of file diff --git a/api/GetNumDisplayChannels.lua b/api/GetNumDisplayChannels.lua new file mode 100644 index 0000000..79999e6 --- /dev/null +++ b/api/GetNumDisplayChannels.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number channelCount +---Returns the number of entries in the channel list display +function GetNumDisplayChannels() end \ No newline at end of file diff --git a/api/GetNumDungeonMapLevels.lua b/api/GetNumDungeonMapLevels.lua new file mode 100644 index 0000000..9bb4c39 --- /dev/null +++ b/api/GetNumDungeonMapLevels.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numLevels +---@return number firstLevel +---Returns the number of map images for the world map's current zone. Used in zones with more than one "floor" or area such as Dalaran and several Wrath of the Lich King dungeons and raids. The returns vary depending on your current location in the zone. If you're in a "micro dungeon" (see GetMapInfo), you'll get different values. firstFloor is the absolute starting value, while numLevels is the number of steps to go past that. Can be used to derive the number in the internal floor names list that the "1" floor corresponds to. For example, in Dun Morogh's "Grizzled Den", it returns {1,7} - because we're on the first floor of _G['DUNGEON_FLOOR_DUNMOROGH7']=="Grizzled Den" +function GetNumDungeonMapLevels() end \ No newline at end of file diff --git a/api/GetNumEquipmentSets.lua b/api/GetNumEquipmentSets.lua new file mode 100644 index 0000000..50bebdd --- /dev/null +++ b/api/GetNumEquipmentSets.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numSets +---Returns the number of saved equipment sets +function GetNumEquipmentSets() end \ No newline at end of file diff --git a/api/GetNumFactions.lua b/api/GetNumFactions.lua new file mode 100644 index 0000000..c84a07d --- /dev/null +++ b/api/GetNumFactions.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numFactions +---Returns the number of entries in the reputation UI. Entries in the reputation UI can be major group headers (Classic, Burning Crusade, Wrath of the Lich King, Inactive, etc.), the sub-group headers within them (Alliance Forces, Steamwheedle Cartel, Horde Expedition, Shattrath City, etc.), or individual factions (Darkmoon Faire, Orgrimmar, Honor Hold, Kirin Tor, etc.). This function returns not the total number of factions (and headers) known, but the number which should currently be visible in the UI according to the expanded/collapsed state of headers. +function GetNumFactions() end \ No newline at end of file diff --git a/api/GetNumFlexRaidDungeons.lua b/api/GetNumFlexRaidDungeons.lua new file mode 100644 index 0000000..2fa0fb2 --- /dev/null +++ b/api/GetNumFlexRaidDungeons.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumFlexRaidDungeons() end \ No newline at end of file diff --git a/api/GetNumFlyouts.lua b/api/GetNumFlyouts.lua new file mode 100644 index 0000000..a690848 --- /dev/null +++ b/api/GetNumFlyouts.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numFlyouts +---Returns the number of flyout actions in the UI. Examples of flyouts are the mage portal button and the warlock and hunter pet summoning buttons. These flyouts can be placed in action buttons. +function GetNumFlyouts() end \ No newline at end of file diff --git a/api/GetNumFrames.lua b/api/GetNumFrames.lua new file mode 100644 index 0000000..18c5ffe --- /dev/null +++ b/api/GetNumFrames.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numFrames +---Returns the number of existing Frame objects (and derivatives). Only counts Frame objects and derivatives thereof (e.g. Button, Minimap, and StatusBar; but not FontString, AnimationGroup, and Texture). +function GetNumFrames() end \ No newline at end of file diff --git a/api/GetNumFriends.lua b/api/GetNumFriends.lua new file mode 100644 index 0000000..a6377d0 --- /dev/null +++ b/api/GetNumFriends.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numFriends +---@return number numFriendsOnline +---Returns the number of characters and online characters on the player's friends list +function GetNumFriends() end \ No newline at end of file diff --git a/api/GetNumGlyphSockets.lua b/api/GetNumGlyphSockets.lua new file mode 100644 index 0000000..9968894 --- /dev/null +++ b/api/GetNumGlyphSockets.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Currently unused. Use the constant NUM_GLYPH_SLOTS instead. +function GetNumGlyphSockets() end \ No newline at end of file diff --git a/api/GetNumGlyphs.lua b/api/GetNumGlyphs.lua new file mode 100644 index 0000000..00b1f06 --- /dev/null +++ b/api/GetNumGlyphs.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numGlyphs +---Returns the total amount of glyphs for the player's class +function GetNumGlyphs() end \ No newline at end of file diff --git a/api/GetNumGossipActiveQuests.lua b/api/GetNumGossipActiveQuests.lua new file mode 100644 index 0000000..e4c3986 --- /dev/null +++ b/api/GetNumGossipActiveQuests.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number num +---Returns the number of quests which can be turned in to the current Gossip NPC. These quests are displayed with a question mark icon in the default UI's GossipFrame. +function GetNumGossipActiveQuests() end \ No newline at end of file diff --git a/api/GetNumGossipAvailableQuests.lua b/api/GetNumGossipAvailableQuests.lua new file mode 100644 index 0000000..a0fc3a2 --- /dev/null +++ b/api/GetNumGossipAvailableQuests.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number num +---Returns the number of quests available from the current Gossip NPC. These quests are displayed with an exclamation mark icon in the default UI's GossipFrame. +function GetNumGossipAvailableQuests() end \ No newline at end of file diff --git a/api/GetNumGossipOptions.lua b/api/GetNumGossipOptions.lua new file mode 100644 index 0000000..0d12d03 --- /dev/null +++ b/api/GetNumGossipOptions.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numOptions +---Returns the number of non-quest dialog options for the current Gossip NPC. Used by the default UI to skip greeting gossip for NPCs which provide only a greeting and one gossip option leading to the NPC's main interaction type (e.g. flight masters, merchants). +function GetNumGossipOptions() end \ No newline at end of file diff --git a/api/GetNumGroupMembers.lua b/api/GetNumGroupMembers.lua new file mode 100644 index 0000000..7a041a9 --- /dev/null +++ b/api/GetNumGroupMembers.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number playerNumber +---Return number of players in current party/raid. +function GetNumGroupMembers() end \ No newline at end of file diff --git a/api/GetNumGuildApplicants.lua b/api/GetNumGuildApplicants.lua new file mode 100644 index 0000000..3062f2f --- /dev/null +++ b/api/GetNumGuildApplicants.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumGuildApplicants() end \ No newline at end of file diff --git a/api/GetNumGuildBankMoneyTransactions.lua b/api/GetNumGuildBankMoneyTransactions.lua new file mode 100644 index 0000000..14f5368 --- /dev/null +++ b/api/GetNumGuildBankMoneyTransactions.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numTransactions +---Returns the number of transactions in the guild bank money log +function GetNumGuildBankMoneyTransactions() end \ No newline at end of file diff --git a/api/GetNumGuildBankTabs.lua b/api/GetNumGuildBankTabs.lua new file mode 100644 index 0000000..1114b37 --- /dev/null +++ b/api/GetNumGuildBankTabs.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numTabs +---Returns the number of purchased tabs in the guild bank. Returns valid information even if the player is not interacting with a guild bank vault. +function GetNumGuildBankTabs() end \ No newline at end of file diff --git a/api/GetNumGuildBankTransactions.lua b/api/GetNumGuildBankTransactions.lua new file mode 100644 index 0000000..d697666 --- /dev/null +++ b/api/GetNumGuildBankTransactions.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param tab number +---@return number numTransactions +---Returns the number of entries in a guild bank tab's transaction log. Only returns valid information following the GUILDBANKLOG_UPDATE event which fires after calling QueryGuildBankLog(). +function GetNumGuildBankTransactions(tab) end \ No newline at end of file diff --git a/api/GetNumGuildChallenges.lua b/api/GetNumGuildChallenges.lua new file mode 100644 index 0000000..0768424 --- /dev/null +++ b/api/GetNumGuildChallenges.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumGuildChallenges() end \ No newline at end of file diff --git a/api/GetNumGuildEvents.lua b/api/GetNumGuildEvents.lua new file mode 100644 index 0000000..e3c3e47 --- /dev/null +++ b/api/GetNumGuildEvents.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numEvents +---Returns the number of entries in the guild event log. Only returns valid data after calling QueryGuildEventLog() and the following GUILD_EVENT_LOG_UPDATE event has fired. +function GetNumGuildEvents() end \ No newline at end of file diff --git a/api/GetNumGuildMembers.lua b/api/GetNumGuildMembers.lua new file mode 100644 index 0000000..99b59c7 --- /dev/null +++ b/api/GetNumGuildMembers.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numGuildMembers +---@return number numOnline +---@return number numOnlineAndMobile +---Returns the number of members in the guild roster +function GetNumGuildMembers() end \ No newline at end of file diff --git a/api/GetNumGuildMembershipRequests.lua b/api/GetNumGuildMembershipRequests.lua new file mode 100644 index 0000000..404d49c --- /dev/null +++ b/api/GetNumGuildMembershipRequests.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumGuildMembershipRequests() end \ No newline at end of file diff --git a/api/GetNumGuildNews.lua b/api/GetNumGuildNews.lua new file mode 100644 index 0000000..702e08c --- /dev/null +++ b/api/GetNumGuildNews.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numNews +---Returns the total amount of guild news (filtered) +function GetNumGuildNews() end \ No newline at end of file diff --git a/api/GetNumGuildPerks.lua b/api/GetNumGuildPerks.lua new file mode 100644 index 0000000..c6eca81 --- /dev/null +++ b/api/GetNumGuildPerks.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numPerks +---Returns the total amount of guild perks (including unavailable ones) +function GetNumGuildPerks() end \ No newline at end of file diff --git a/api/GetNumGuildRewards.lua b/api/GetNumGuildRewards.lua new file mode 100644 index 0000000..10f6f40 --- /dev/null +++ b/api/GetNumGuildRewards.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numRewards +---Return the total amount of guild rewards (including unavailable ones) +function GetNumGuildRewards() end \ No newline at end of file diff --git a/api/GetNumGuildTradeSkill.lua b/api/GetNumGuildTradeSkill.lua new file mode 100644 index 0000000..19fc017 --- /dev/null +++ b/api/GetNumGuildTradeSkill.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Returns the number of people and headers currently visible in the profession view of your guild window. This functions returns the number of people (including the headers that are also counted as one player each) which you can currently see in your guild profession window. If you select "Show offline Members" they will also be counted. To make things clear a small example: let's assume you have all professions in your guild and the headers are all collapsed then this will return 11 (as of WoW 4.0). If you have 7 alchemists, 4 of them are online and you have not checked "Show Offline Members" then this will return 15. If you check the box to show all members then this will return 18. +function GetNumGuildTradeSkill() end \ No newline at end of file diff --git a/api/GetNumIgnores.lua b/api/GetNumIgnores.lua new file mode 100644 index 0000000..e34ac85 --- /dev/null +++ b/api/GetNumIgnores.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numIgnores +---Returns the number of characters on the player's ignore list +function GetNumIgnores() end \ No newline at end of file diff --git a/api/GetNumItemUpgradeEffects.lua b/api/GetNumItemUpgradeEffects.lua new file mode 100644 index 0000000..6dc1a82 --- /dev/null +++ b/api/GetNumItemUpgradeEffects.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumItemUpgradeEffects() end \ No newline at end of file diff --git a/api/GetNumLanguages.lua b/api/GetNumLanguages.lua new file mode 100644 index 0000000..f539ad9 --- /dev/null +++ b/api/GetNumLanguages.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number languages +---Returns the number of languages the player character can speak +function GetNumLanguages() end \ No newline at end of file diff --git a/api/GetNumLootItems.lua b/api/GetNumLootItems.lua new file mode 100644 index 0000000..1be5085 --- /dev/null +++ b/api/GetNumLootItems.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numItems +---Returns the number of items available to be looted +function GetNumLootItems() end \ No newline at end of file diff --git a/api/GetNumMacros.lua b/api/GetNumMacros.lua new file mode 100644 index 0000000..2a1dddc --- /dev/null +++ b/api/GetNumMacros.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numAccountMacros +---@return number numCharacterMacros +---Returns the number of macros the player has stored +function GetNumMacros() end \ No newline at end of file diff --git a/api/GetNumMapDebugObjects.lua b/api/GetNumMapDebugObjects.lua new file mode 100644 index 0000000..649c09e --- /dev/null +++ b/api/GetNumMapDebugObjects.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumMapDebugObjects() end \ No newline at end of file diff --git a/api/GetNumMapLandmarks.lua b/api/GetNumMapLandmarks.lua new file mode 100644 index 0000000..77661d1 --- /dev/null +++ b/api/GetNumMapLandmarks.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numLandmarks +---Returns the number of landmarks on the world map. Possible landmarks include PvP objectives (both in battlegrounds and in world PvP areas), town and city markers on continent maps, and special markers such as those used during the Scourge Invasion world event. Some landmarks (such as those for towns on a zone map) exist but are not visible in the default UI. +function GetNumMapLandmarks() end \ No newline at end of file diff --git a/api/GetNumMapOverlays.lua b/api/GetNumMapOverlays.lua new file mode 100644 index 0000000..6de4dd4 --- /dev/null +++ b/api/GetNumMapOverlays.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numOverlays +---Returns the number of overlays for the current world map zone. Map overlays correspond to areas which are "discovered" when entered by the player, "filling in" the blank areas of the world map. +function GetNumMapOverlays() end \ No newline at end of file diff --git a/api/GetNumMembersInRank.lua b/api/GetNumMembersInRank.lua new file mode 100644 index 0000000..e91a6b7 --- /dev/null +++ b/api/GetNumMembersInRank.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumMembersInRank() end \ No newline at end of file diff --git a/api/GetNumMissingLootItems.lua b/api/GetNumMissingLootItems.lua new file mode 100644 index 0000000..7629043 --- /dev/null +++ b/api/GetNumMissingLootItems.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumMissingLootItems() end \ No newline at end of file diff --git a/api/GetNumModifiedClickActions.lua b/api/GetNumModifiedClickActions.lua new file mode 100644 index 0000000..177008a --- /dev/null +++ b/api/GetNumModifiedClickActions.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number num +---Returns the number of modified click actions registered. May return an invalid result if called when no modified click actions have been registered (i.e. early in the UI loading process). +function GetNumModifiedClickActions() end \ No newline at end of file diff --git a/api/GetNumMutes.lua b/api/GetNumMutes.lua new file mode 100644 index 0000000..dc4392d --- /dev/null +++ b/api/GetNumMutes.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numMuted +---Returns the number of characters on the player's mute list +function GetNumMutes() end \ No newline at end of file diff --git a/api/GetNumNamePlateMotionTypes.lua b/api/GetNumNamePlateMotionTypes.lua new file mode 100644 index 0000000..1dfbe23 --- /dev/null +++ b/api/GetNumNamePlateMotionTypes.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumNamePlateMotionTypes() end \ No newline at end of file diff --git a/api/GetNumPackages.lua b/api/GetNumPackages.lua new file mode 100644 index 0000000..6c7d69f --- /dev/null +++ b/api/GetNumPackages.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumPackages() end \ No newline at end of file diff --git a/api/GetNumPetitionNames.lua b/api/GetNumPetitionNames.lua new file mode 100644 index 0000000..1b911b3 --- /dev/null +++ b/api/GetNumPetitionNames.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numNames +---Returns the number of people who have signed the open petition +function GetNumPetitionNames() end \ No newline at end of file diff --git a/api/GetNumQuestChoices.lua b/api/GetNumQuestChoices.lua new file mode 100644 index 0000000..59958de --- /dev/null +++ b/api/GetNumQuestChoices.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numQuestChoices +---Returns the number of available quest rewards from which the player must choose one upon completing the quest presented by a questgiver. Only valid during the accept/decline or completion stages of a quest dialog (following the QUEST_DETAIL or QUEST_COMPLETE events); otherwise may return 0 or a value from the most recently displayed quest. +function GetNumQuestChoices() end \ No newline at end of file diff --git a/api/GetNumQuestCurrencies.lua b/api/GetNumQuestCurrencies.lua new file mode 100644 index 0000000..c6a6379 --- /dev/null +++ b/api/GetNumQuestCurrencies.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumQuestCurrencies() end \ No newline at end of file diff --git a/api/GetNumQuestItemDrops.lua b/api/GetNumQuestItemDrops.lua new file mode 100644 index 0000000..b6a755b --- /dev/null +++ b/api/GetNumQuestItemDrops.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumQuestItemDrops() end \ No newline at end of file diff --git a/api/GetNumQuestItems.lua b/api/GetNumQuestItems.lua new file mode 100644 index 0000000..8c298f9 --- /dev/null +++ b/api/GetNumQuestItems.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numRequiredItems +---Returns the number of different items required to complete the quest presented by a questgiver. Usable following the QUEST_PROGRESS event in which it is determined whether the player can complete the quest. +function GetNumQuestItems() end \ No newline at end of file diff --git a/api/GetNumQuestLeaderBoards.lua b/api/GetNumQuestLeaderBoards.lua new file mode 100644 index 0000000..6ed605c --- /dev/null +++ b/api/GetNumQuestLeaderBoards.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param questIndex number +---@return number numObjectives +---Returns the number of quest objectives for a quest in the player's quest log +function GetNumQuestLeaderBoards(questIndex) end \ No newline at end of file diff --git a/api/GetNumQuestLogChoices.lua b/api/GetNumQuestLogChoices.lua new file mode 100644 index 0000000..f40acb3 --- /dev/null +++ b/api/GetNumQuestLogChoices.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numChoices +---Returns the number of available item reward choices for the selected quest in the quest log. This function refers to quest rewards for which the player is allowed to choose one item from among several; for items always awarded upon quest completion, see GetNumQuestLogRewards. +function GetNumQuestLogChoices() end \ No newline at end of file diff --git a/api/GetNumQuestLogEntries.lua b/api/GetNumQuestLogEntries.lua new file mode 100644 index 0000000..97f32ce --- /dev/null +++ b/api/GetNumQuestLogEntries.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numEntries +---@return number numQuests +---Returns the number of quests and headers in the quest log +function GetNumQuestLogEntries() end \ No newline at end of file diff --git a/api/GetNumQuestLogRewardCurrencies.lua b/api/GetNumQuestLogRewardCurrencies.lua new file mode 100644 index 0000000..0d11e7f --- /dev/null +++ b/api/GetNumQuestLogRewardCurrencies.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumQuestLogRewardCurrencies() end \ No newline at end of file diff --git a/api/GetNumQuestLogRewardFactions.lua b/api/GetNumQuestLogRewardFactions.lua new file mode 100644 index 0000000..51c8461 --- /dev/null +++ b/api/GetNumQuestLogRewardFactions.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumQuestLogRewardFactions() end \ No newline at end of file diff --git a/api/GetNumQuestLogRewards.lua b/api/GetNumQuestLogRewards.lua new file mode 100644 index 0000000..ca52d16 --- /dev/null +++ b/api/GetNumQuestLogRewards.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numRewards +---Returns the number of item rewards for the selected quest in the quest log. This function refers to items always awarded upon quest completion; for quest rewards for which the player is allowed to choose one item from among several, see GetNumQuestLogChoices. +function GetNumQuestLogRewards() end \ No newline at end of file diff --git a/api/GetNumQuestLogTasks.lua b/api/GetNumQuestLogTasks.lua new file mode 100644 index 0000000..98b8dd4 --- /dev/null +++ b/api/GetNumQuestLogTasks.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumQuestLogTasks() end \ No newline at end of file diff --git a/api/GetNumQuestPOIWorldEffects.lua b/api/GetNumQuestPOIWorldEffects.lua new file mode 100644 index 0000000..5d2ceb6 --- /dev/null +++ b/api/GetNumQuestPOIWorldEffects.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumQuestPOIWorldEffects() end \ No newline at end of file diff --git a/api/GetNumQuestRewards.lua b/api/GetNumQuestRewards.lua new file mode 100644 index 0000000..42abbbf --- /dev/null +++ b/api/GetNumQuestRewards.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numQuestRewards +---Returns the number of different items always awarded upon completing the quest presented by a questgiver. Only valid during the accept/decline or completion stages of a quest dialog (following the QUEST_DETAIL or QUEST_COMPLETE events); otherwise may return 0 or a value from the most recently displayed quest. +function GetNumQuestRewards() end \ No newline at end of file diff --git a/api/GetNumQuestWatches.lua b/api/GetNumQuestWatches.lua new file mode 100644 index 0000000..f65df5b --- /dev/null +++ b/api/GetNumQuestWatches.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numWatches +---Returns the number of quests included in the objectives tracker +function GetNumQuestWatches() end \ No newline at end of file diff --git a/api/GetNumRFDungeons.lua b/api/GetNumRFDungeons.lua new file mode 100644 index 0000000..dedcb6c --- /dev/null +++ b/api/GetNumRFDungeons.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numberOfRFDungeons +---Returns the number of raid finder instances. +function GetNumRFDungeons() end \ No newline at end of file diff --git a/api/GetNumRaidProfiles.lua b/api/GetNumRaidProfiles.lua new file mode 100644 index 0000000..2fb0182 --- /dev/null +++ b/api/GetNumRaidProfiles.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumRaidProfiles() end \ No newline at end of file diff --git a/api/GetNumRandomScenarios.lua b/api/GetNumRandomScenarios.lua new file mode 100644 index 0000000..8be5fc4 --- /dev/null +++ b/api/GetNumRandomScenarios.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumRandomScenarios() end \ No newline at end of file diff --git a/api/GetNumRecruitingGuilds.lua b/api/GetNumRecruitingGuilds.lua new file mode 100644 index 0000000..dc486f0 --- /dev/null +++ b/api/GetNumRecruitingGuilds.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumRecruitingGuilds() end \ No newline at end of file diff --git a/api/GetNumRewardCurrencies.lua b/api/GetNumRewardCurrencies.lua new file mode 100644 index 0000000..cbeaaf2 --- /dev/null +++ b/api/GetNumRewardCurrencies.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumRewardCurrencies() end \ No newline at end of file diff --git a/api/GetNumRoutes.lua b/api/GetNumRoutes.lua new file mode 100644 index 0000000..819117e --- /dev/null +++ b/api/GetNumRoutes.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number numHops +---Returns the number of hops from the current location to another taxi node. Only returns valid data while interacting with a flight master (i.e. between the TAXIMAP_OPENED and TAXIMAP_CLOSED events). +function GetNumRoutes(index) end \ No newline at end of file diff --git a/api/GetNumSavedInstances.lua b/api/GetNumSavedInstances.lua new file mode 100644 index 0000000..5d7e071 --- /dev/null +++ b/api/GetNumSavedInstances.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number savedInstances +---Returns the number of instances to which the player is saved +function GetNumSavedInstances() end \ No newline at end of file diff --git a/api/GetNumSavedWorldBosses.lua b/api/GetNumSavedWorldBosses.lua new file mode 100644 index 0000000..53c437e --- /dev/null +++ b/api/GetNumSavedWorldBosses.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumSavedWorldBosses() end \ No newline at end of file diff --git a/api/GetNumScenarios.lua b/api/GetNumScenarios.lua new file mode 100644 index 0000000..fa41df7 --- /dev/null +++ b/api/GetNumScenarios.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumScenarios() end \ No newline at end of file diff --git a/api/GetNumShapeshiftForms.lua b/api/GetNumShapeshiftForms.lua new file mode 100644 index 0000000..bed0a9c --- /dev/null +++ b/api/GetNumShapeshiftForms.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numForms +---Returns the number of abilities to be presented on the stance/shapeshift bar +function GetNumShapeshiftForms() end \ No newline at end of file diff --git a/api/GetNumSockets.lua b/api/GetNumSockets.lua new file mode 100644 index 0000000..8885d6a --- /dev/null +++ b/api/GetNumSockets.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numSockets +---Returns the number of sockets on the item currently being socketed. Only returns valid information when the Item Socketing UI is open (i.e. between the SOCKET_INFO_UPDATE and SOCKET_INFO_CLOSE events). +function GetNumSockets() end \ No newline at end of file diff --git a/api/GetNumSpecGroups.lua b/api/GetNumSpecGroups.lua new file mode 100644 index 0000000..0ca0271 --- /dev/null +++ b/api/GetNumSpecGroups.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumSpecGroups() end \ No newline at end of file diff --git a/api/GetNumSpecializations.lua b/api/GetNumSpecializations.lua new file mode 100644 index 0000000..a1b2130 --- /dev/null +++ b/api/GetNumSpecializations.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumSpecializations() end \ No newline at end of file diff --git a/api/GetNumSpecializationsForClassID.lua b/api/GetNumSpecializationsForClassID.lua new file mode 100644 index 0000000..5122e66 --- /dev/null +++ b/api/GetNumSpecializationsForClassID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumSpecializationsForClassID() end \ No newline at end of file diff --git a/api/GetNumSpellTabs.lua b/api/GetNumSpellTabs.lua new file mode 100644 index 0000000..dab827d --- /dev/null +++ b/api/GetNumSpellTabs.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numTabs +---Returns the number of tabs in the player's spellbook +function GetNumSpellTabs() end \ No newline at end of file diff --git a/api/GetNumStationeries.lua b/api/GetNumStationeries.lua new file mode 100644 index 0000000..7b3acc7 --- /dev/null +++ b/api/GetNumStationeries.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numStationeries +---Returns the number of available stationery types. Always returns 1; the stationery feature for sending mail is not implemented in the current version of World of Warcraft. +function GetNumStationeries() end \ No newline at end of file diff --git a/api/GetNumSubgroupMembers.lua b/api/GetNumSubgroupMembers.lua new file mode 100644 index 0000000..d1d5fb1 --- /dev/null +++ b/api/GetNumSubgroupMembers.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number playerNumber +---Return number of other players in current player’s raid subgroup. +function GetNumSubgroupMembers() end \ No newline at end of file diff --git a/api/GetNumTitles.lua b/api/GetNumTitles.lua new file mode 100644 index 0000000..5681a69 --- /dev/null +++ b/api/GetNumTitles.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numTitles +---Returns the number of available player titles. Includes all titles, not just those earned by the player +function GetNumTitles() end \ No newline at end of file diff --git a/api/GetNumTrackedAchievements.lua b/api/GetNumTrackedAchievements.lua new file mode 100644 index 0000000..eb050d3 --- /dev/null +++ b/api/GetNumTrackedAchievements.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number count +---Returns the number of achievements flagged for display in the objectives tracker UI +function GetNumTrackedAchievements() end \ No newline at end of file diff --git a/api/GetNumTrackingTypes.lua b/api/GetNumTrackingTypes.lua new file mode 100644 index 0000000..df50ce4 --- /dev/null +++ b/api/GetNumTrackingTypes.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number count +---Returns the number of available minimap object/unit tracking abilities +function GetNumTrackingTypes() end \ No newline at end of file diff --git a/api/GetNumTradeSkills.lua b/api/GetNumTradeSkills.lua new file mode 100644 index 0000000..b93885c --- /dev/null +++ b/api/GetNumTradeSkills.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numSkills +---Returns the number of entries in the trade skill listing. Entries include both group headers and individual trade skill recipes. Reflects the list as it should currently be displayed, not necessarily the complete list -- if headers are collapsed or a filter is enabled, a smaller number will be returned. Returns 0 if a trade skill is not "open". +function GetNumTradeSkills() end \ No newline at end of file diff --git a/api/GetNumTrainerServices.lua b/api/GetNumTrainerServices.lua new file mode 100644 index 0000000..7228d1e --- /dev/null +++ b/api/GetNumTrainerServices.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numServices +---Returns the number of entries in the trainer service listing. Entries include both group headers and individual trainer services (i.e spells or recipes to be purchased). Reflects the list as it should currently be displayed, not necessarily the complete list -- if headers are collapsed or a filter is enabled, a smaller number will be returned. Returns 0 if not interacting with a trainer. +function GetNumTrainerServices() end \ No newline at end of file diff --git a/api/GetNumUnspentTalents.lua b/api/GetNumUnspentTalents.lua new file mode 100644 index 0000000..bc74eef --- /dev/null +++ b/api/GetNumUnspentTalents.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumUnspentTalents() end \ No newline at end of file diff --git a/api/GetNumVoiceSessionMembersBySessionID.lua b/api/GetNumVoiceSessionMembersBySessionID.lua new file mode 100644 index 0000000..6ed77e4 --- /dev/null +++ b/api/GetNumVoiceSessionMembersBySessionID.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param sessionId number +---@return number numMembers +---Returns the number of members in a voice channel +function GetNumVoiceSessionMembersBySessionID(sessionId) end \ No newline at end of file diff --git a/api/GetNumVoiceSessions.lua b/api/GetNumVoiceSessions.lua new file mode 100644 index 0000000..9a9af34 --- /dev/null +++ b/api/GetNumVoiceSessions.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number count +---Returns the number of available voice channels. Returns 0 if voice chat is disabled. +function GetNumVoiceSessions() end \ No newline at end of file diff --git a/api/GetNumVoidTransferDeposit.lua b/api/GetNumVoidTransferDeposit.lua new file mode 100644 index 0000000..2a5c181 --- /dev/null +++ b/api/GetNumVoidTransferDeposit.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumVoidTransferDeposit() end \ No newline at end of file diff --git a/api/GetNumVoidTransferWithdrawal.lua b/api/GetNumVoidTransferWithdrawal.lua new file mode 100644 index 0000000..bd7aa02 --- /dev/null +++ b/api/GetNumVoidTransferWithdrawal.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumVoidTransferWithdrawal() end \ No newline at end of file diff --git a/api/GetNumWarGameTypes.lua b/api/GetNumWarGameTypes.lua new file mode 100644 index 0000000..4da2b79 --- /dev/null +++ b/api/GetNumWarGameTypes.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumWarGameTypes() end \ No newline at end of file diff --git a/api/GetNumWhoResults.lua b/api/GetNumWhoResults.lua new file mode 100644 index 0000000..ff0c669 --- /dev/null +++ b/api/GetNumWhoResults.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numResults +---@return number totalCount +---Returns the number of results from a Who system query +function GetNumWhoResults() end \ No newline at end of file diff --git a/api/GetNumWorldPVPAreas.lua b/api/GetNumWorldPVPAreas.lua new file mode 100644 index 0000000..c299029 --- /dev/null +++ b/api/GetNumWorldPVPAreas.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumWorldPVPAreas() end \ No newline at end of file diff --git a/api/GetNumWorldStateUI.lua b/api/GetNumWorldStateUI.lua new file mode 100644 index 0000000..bdd39c5 --- /dev/null +++ b/api/GetNumWorldStateUI.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numUI +---Returns the number of world state UI elements. World State UI elements include PvP, instance, and quest objective information (displayed at the top center of the screen in the default UI) as well as more specific information for "control point" style PvP objectives. Examples: the Horde/Alliance score in Arathi Basin, the tower status and capture progress bars in Hellfire Peninsula, the progress text in the Black Morass and Violet Hold instances, and the event status text for quests The Light of Dawn and The Battle For The Undercity. +function GetNumWorldStateUI() end \ No newline at end of file diff --git a/api/GetNumberOfDetailTiles.lua b/api/GetNumberOfDetailTiles.lua new file mode 100644 index 0000000..66110f3 --- /dev/null +++ b/api/GetNumberOfDetailTiles.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetNumberOfDetailTiles() end \ No newline at end of file diff --git a/api/GetOSLocale.lua b/api/GetOSLocale.lua new file mode 100644 index 0000000..9b41b8b --- /dev/null +++ b/api/GetOSLocale.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetOSLocale() end \ No newline at end of file diff --git a/api/GetObjectiveText.lua b/api/GetObjectiveText.lua new file mode 100644 index 0000000..3008889 --- /dev/null +++ b/api/GetObjectiveText.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string questObjective +---Returns a summary of objectives for the quest offered by a questgiver. Only valid when the questgiver UI is showing the accept/decline stage of a quest dialog (between the QUEST_COMPLETE and QUEST_FINISHED events); otherwise may return the empty string or a value from the most recently displayed quest. +function GetObjectiveText() end \ No newline at end of file diff --git a/api/GetOptOutOfLoot.lua b/api/GetOptOutOfLoot.lua new file mode 100644 index 0000000..6e1a56a --- /dev/null +++ b/api/GetOptOutOfLoot.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isOptOut +---Returns whether the player has opted out of loot rolls. When opting out, no prompt will be shown for loot which ordinarily would prompt the player to roll (need/greed) or pass; the loot rolling process will continue for other group members as if the player had chosen to pass on every roll. +function GetOptOutOfLoot() end \ No newline at end of file diff --git a/api/GetOutdoorPVPWaitTime.lua b/api/GetOutdoorPVPWaitTime.lua new file mode 100644 index 0000000..771a122 --- /dev/null +++ b/api/GetOutdoorPVPWaitTime.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number waitTime +---Returns the world PvP wait time for the currently selected zone, nil otherwise. Authors looking for information regarding specific world PvP zones should consider using GetWorldPVPAreaInfo() instead. +function GetOutdoorPVPWaitTime() end \ No newline at end of file diff --git a/api/GetOverrideAPBySpellPower.lua b/api/GetOverrideAPBySpellPower.lua new file mode 100644 index 0000000..5b93974 --- /dev/null +++ b/api/GetOverrideAPBySpellPower.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetOverrideAPBySpellPower() end \ No newline at end of file diff --git a/api/GetOverrideBarIndex.lua b/api/GetOverrideBarIndex.lua new file mode 100644 index 0000000..59a346e --- /dev/null +++ b/api/GetOverrideBarIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetOverrideBarIndex() end \ No newline at end of file diff --git a/api/GetOverrideBarSkin.lua b/api/GetOverrideBarSkin.lua new file mode 100644 index 0000000..17c1e30 --- /dev/null +++ b/api/GetOverrideBarSkin.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetOverrideBarSkin() end \ No newline at end of file diff --git a/api/GetOverrideSpellPowerByAP.lua b/api/GetOverrideSpellPowerByAP.lua new file mode 100644 index 0000000..28c2c00 --- /dev/null +++ b/api/GetOverrideSpellPowerByAP.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number spellPower +---Returns how much spell power is returned by attack power (Shaman). Currently valid for Enhancement Shamans only. +function GetOverrideSpellPowerByAP() end \ No newline at end of file diff --git a/api/GetOwnerAuctionItems.lua b/api/GetOwnerAuctionItems.lua new file mode 100644 index 0000000..3f239c0 --- /dev/null +++ b/api/GetOwnerAuctionItems.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Requests data from the server for the list of auctions created by the player. The AUCTION_OWNED_LIST_UPDATE event fires if new data is available; listing information can then be retrieved using GetAuctionItemInfo() or other Auction APIs. +function GetOwnerAuctionItems() end \ No newline at end of file diff --git a/api/GetPOITextureCoords.lua b/api/GetPOITextureCoords.lua new file mode 100644 index 0000000..fdfae80 --- /dev/null +++ b/api/GetPOITextureCoords.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param textureIndex number +---@return number x1 +---@return number x2 +---@return number y1 +---@return number y2 +---Return texture coordinates of POI icon. Coordinates usable with Interface\Minimap\POIIcons texture. +function GetPOITextureCoords(textureIndex) end \ No newline at end of file diff --git a/api/GetPVPDesired.lua b/api/GetPVPDesired.lua new file mode 100644 index 0000000..ac92b42 --- /dev/null +++ b/api/GetPVPDesired.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number isPVPDesired +---Returns whether the player has manually enabled PvP status. Only indicates whether the player has manually and directly enabled his PvP flag (e.g. by typing "/pvp" or using the default UI's menu when right-clicking the player portrait); returns 0 if the player only became PvP flagged by attacking an enemy player, entering an enemy zone, etc. +function GetPVPDesired() end \ No newline at end of file diff --git a/api/GetPVPLifetimeStats.lua b/api/GetPVPLifetimeStats.lua new file mode 100644 index 0000000..47c0903 --- /dev/null +++ b/api/GetPVPLifetimeStats.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number hk +---@return number highestRank +---Returns the player's lifetime total of honorable kills and highest rank achieved. Highest rank achieved applies only to the older PvP rewards system that was abandoned with the WoW 2.0 patch, but is still accurate for players who participated in it. +function GetPVPLifetimeStats() end \ No newline at end of file diff --git a/api/GetPVPRewards.lua b/api/GetPVPRewards.lua new file mode 100644 index 0000000..9bdbcab --- /dev/null +++ b/api/GetPVPRewards.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number pointsThisWeek +---@return number maxPointsThisWeek +---@return number tier2Quantity +---@return number tier2Limit +---@return string tier1Quantity +---@return number tier1Limit +---Returns information about Conquest Point cap. +function GetPVPRewards() end \ No newline at end of file diff --git a/api/GetPVPRoles.lua b/api/GetPVPRoles.lua new file mode 100644 index 0000000..c6a4934 --- /dev/null +++ b/api/GetPVPRoles.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetPVPRoles() end \ No newline at end of file diff --git a/api/GetPVPSessionStats.lua b/api/GetPVPSessionStats.lua new file mode 100644 index 0000000..bedfa92 --- /dev/null +++ b/api/GetPVPSessionStats.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number honorKills +---@return number honorPoints +---Returns the number of kills and honor points scored by the player since logging in +function GetPVPSessionStats() end \ No newline at end of file diff --git a/api/GetPVPTimer.lua b/api/GetPVPTimer.lua new file mode 100644 index 0000000..bddb5d3 --- /dev/null +++ b/api/GetPVPTimer.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number timer +---Returns the amount of time until the player's PVP flag expires. Returns 300000 or higher if the player's PvP flag is manually enabled or if the player is in a PvP or enemy zone. +function GetPVPTimer() end \ No newline at end of file diff --git a/api/GetPVPYesterdayStats.lua b/api/GetPVPYesterdayStats.lua new file mode 100644 index 0000000..edfa09d --- /dev/null +++ b/api/GetPVPYesterdayStats.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number honorKills +---@return number honorPoints +---Returns the number of kills and honor points scored by the player on the previous day +function GetPVPYesterdayStats() end \ No newline at end of file diff --git a/api/GetPackageInfo.lua b/api/GetPackageInfo.lua new file mode 100644 index 0000000..2232f48 --- /dev/null +++ b/api/GetPackageInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetPackageInfo() end \ No newline at end of file diff --git a/api/GetParryChance.lua b/api/GetParryChance.lua new file mode 100644 index 0000000..460e5cb --- /dev/null +++ b/api/GetParryChance.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number chance +---Returns the player's parry chance +function GetParryChance() end \ No newline at end of file diff --git a/api/GetPartyAssignment.lua b/api/GetPartyAssignment.lua new file mode 100644 index 0000000..2c4ec95 --- /dev/null +++ b/api/GetPartyAssignment.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param assignment MAINTANK +---@param MAINASSIST +---@param MAINTANK +---@param unit string +---@param name string +---@param exactMatch boolean +---@return 1nil isAssigned +---Returns whether a party/raid member is assigned a specific group role +function GetPartyAssignment(assignment, MAINASSIST, MAINTANK, unit, name, exactMatch) end \ No newline at end of file diff --git a/api/GetPartyLFGBackfillInfo.lua b/api/GetPartyLFGBackfillInfo.lua new file mode 100644 index 0000000..33af13a --- /dev/null +++ b/api/GetPartyLFGBackfillInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetPartyLFGBackfillInfo() end \ No newline at end of file diff --git a/api/GetPartyLFGID.lua b/api/GetPartyLFGID.lua new file mode 100644 index 0000000..7834b98 --- /dev/null +++ b/api/GetPartyLFGID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetPartyLFGID() end \ No newline at end of file diff --git a/api/GetPersonalRatedInfo.lua b/api/GetPersonalRatedInfo.lua new file mode 100644 index 0000000..a487aad --- /dev/null +++ b/api/GetPersonalRatedInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetPersonalRatedInfo() end \ No newline at end of file diff --git a/api/GetPetActionCooldown.lua b/api/GetPetActionCooldown.lua new file mode 100644 index 0000000..7955f25 --- /dev/null +++ b/api/GetPetActionCooldown.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number start +---@return number duration +---@return number enable +---Returns cooldown information about a given pet action slot +function GetPetActionCooldown(index) end \ No newline at end of file diff --git a/api/GetPetActionInfo.lua b/api/GetPetActionInfo.lua new file mode 100644 index 0000000..3323473 --- /dev/null +++ b/api/GetPetActionInfo.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---@return string subtext +---@return string texture +---@return 1nil isToken +---@return 1nil isActive +---@return 1nil autoCastAllowed +---@return 1nil autoCastEnabled +---Returns information about a pet action +function GetPetActionInfo(index) end \ No newline at end of file diff --git a/api/GetPetActionSlotUsable.lua b/api/GetPetActionSlotUsable.lua new file mode 100644 index 0000000..1722a11 --- /dev/null +++ b/api/GetPetActionSlotUsable.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return 1nil usable +---Returns whether a pet action can be used. Used in the default UI to show pet actions as grayed out when the pet cannot be commanded to perform them (e.g. when the player or pet is stunned). +function GetPetActionSlotUsable(index) end \ No newline at end of file diff --git a/api/GetPetActionsUsable.lua b/api/GetPetActionsUsable.lua new file mode 100644 index 0000000..cd2cd4c --- /dev/null +++ b/api/GetPetActionsUsable.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil petActionsUsable +---Returns whether the pet's actions are usable. Note: GetPetActionSlotUsable can return nil for individual actions even if GetPetActionsUsable returns 1 (though not the other way around). +function GetPetActionsUsable() end \ No newline at end of file diff --git a/api/GetPetExperience.lua b/api/GetPetExperience.lua new file mode 100644 index 0000000..6642f56 --- /dev/null +++ b/api/GetPetExperience.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number currXP +---@return number nextXP +---Returns information about experience points for the player's pet +function GetPetExperience() end \ No newline at end of file diff --git a/api/GetPetFoodTypes.lua b/api/GetPetFoodTypes.lua new file mode 100644 index 0000000..634dccc --- /dev/null +++ b/api/GetPetFoodTypes.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return Meat ... +---@return Bread +---@return Cheese +---@return Fish +---@return Fruit +---@return Fungus +---@return Meat +---Returns a list of the food types the player's pet will eat +function GetPetFoodTypes() end \ No newline at end of file diff --git a/api/GetPetIcon.lua b/api/GetPetIcon.lua new file mode 100644 index 0000000..1ca4ef9 --- /dev/null +++ b/api/GetPetIcon.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string texture +---Returns an icon representing the current pet. Used in the default Pet Stables and Talent UIs for hunter pets; returns nil for other pets. +function GetPetIcon() end \ No newline at end of file diff --git a/api/GetPetMeleeHaste.lua b/api/GetPetMeleeHaste.lua new file mode 100644 index 0000000..d17d508 --- /dev/null +++ b/api/GetPetMeleeHaste.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetPetMeleeHaste() end \ No newline at end of file diff --git a/api/GetPetSpellBonusDamage.lua b/api/GetPetSpellBonusDamage.lua new file mode 100644 index 0000000..54d7ce7 --- /dev/null +++ b/api/GetPetSpellBonusDamage.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetPetSpellBonusDamage() end \ No newline at end of file diff --git a/api/GetPetTalentTree.lua b/api/GetPetTalentTree.lua new file mode 100644 index 0000000..a6e5bba --- /dev/null +++ b/api/GetPetTalentTree.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string talent +---Returns the name of the talent tree used by the player's current pet. Hunter pets use one of three different talent trees according to pet type. Returns nil if the player does not have a pet or the player's current pet does not use talents (i.e. warlock pets, quest pets, etc.) +function GetPetTalentTree() end \ No newline at end of file diff --git a/api/GetPetTimeRemaining.lua b/api/GetPetTimeRemaining.lua new file mode 100644 index 0000000..a9ba73b --- /dev/null +++ b/api/GetPetTimeRemaining.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number petTimeRemaining +---Returns the time remaining before a temporary pet is automatically dismissed. Temporary pets include priests' Shadowfriend, mages' Water Elemental, and various quest-related pets. +function GetPetTimeRemaining() end \ No newline at end of file diff --git a/api/GetPetitionInfo.lua b/api/GetPetitionInfo.lua new file mode 100644 index 0000000..5d416a9 --- /dev/null +++ b/api/GetPetitionInfo.lua @@ -0,0 +1,13 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return guild petitionType +---@return arena +---@return guild +---@return string title +---@return string bodyText +---@return number maxSignatures +---@return string originatorName +---@return 1nil isOriginator +---@return number minSignatures +---Returns information about the currently open petition +function GetPetitionInfo() end \ No newline at end of file diff --git a/api/GetPetitionNameInfo.lua b/api/GetPetitionNameInfo.lua new file mode 100644 index 0000000..74e0bc9 --- /dev/null +++ b/api/GetPetitionNameInfo.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---Returns the name of a character who has signed the currently offered petition +function GetPetitionNameInfo(index) end \ No newline at end of file diff --git a/api/GetPlayerFacing.lua b/api/GetPlayerFacing.lua new file mode 100644 index 0000000..7960836 --- /dev/null +++ b/api/GetPlayerFacing.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number facing +---Returns the player's orientation (heading). Indicates the direction the player model is (normally) facing and in which the player will move if he begins walking forward, not the camera orientation. Value Value is equal to 0 for North and increases counterclockwise. Full 360° is equal to 2π. Example Direction Value Dump North 0 −0 North West .25π ~0.78538751602173 West .5π ~1.5707750320435 South π ~3.1415500640870 East 1.5π ~4.7124104499817 North East 1.75π ~5.4977979660034 +function GetPlayerFacing() end \ No newline at end of file diff --git a/api/GetPlayerInfoByGUID.lua b/api/GetPlayerInfoByGUID.lua new file mode 100644 index 0000000..f2a0690 --- /dev/null +++ b/api/GetPlayerInfoByGUID.lua @@ -0,0 +1,15 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param guid string +---@return string class +---@return string classFilename +---@return string race +---@return string raceFilename +---@return 3 sex +---@return 1 +---@return 2 +---@return 3 +---@return string name +---@return string realm +---Returns information about a player character identified by globally unique identifier. Returns nil if given the GUID of a non-player unit. The leading 0x may be omitted. +function GetPlayerInfoByGUID(guid) end \ No newline at end of file diff --git a/api/GetPlayerMapPosition.lua b/api/GetPlayerMapPosition.lua new file mode 100644 index 0000000..9cf3446 --- /dev/null +++ b/api/GetPlayerMapPosition.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return number unitX +---@return number unitY +---Returns the position of a unit in the player's party or raid on the world map. Returns 0,0 if the unit's location is not visible on the current world map. +function GetPlayerMapPosition(unit) end \ No newline at end of file diff --git a/api/GetPlayerTradeCurrency.lua b/api/GetPlayerTradeCurrency.lua new file mode 100644 index 0000000..5395c86 --- /dev/null +++ b/api/GetPlayerTradeCurrency.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetPlayerTradeCurrency() end \ No newline at end of file diff --git a/api/GetPlayerTradeMoney.lua b/api/GetPlayerTradeMoney.lua new file mode 100644 index 0000000..c3db37d --- /dev/null +++ b/api/GetPlayerTradeMoney.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number amount +---Returns the amount of money offered for trade by the player +function GetPlayerTradeMoney() end \ No newline at end of file diff --git a/api/GetPossessInfo.lua b/api/GetPossessInfo.lua new file mode 100644 index 0000000..0724c9b --- /dev/null +++ b/api/GetPossessInfo.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string texture +---@return string name +---Returns information about special actions available while the player possesses another unit. Used in the default UI to show additional special actions (e.g. canceling possession) while the player possesses another unit through an ability such as Eyes of the Beast or Mind Control. Does not apply to actions (spells) belonging to the possessed unit; those are regular actions (see GetActionInfo()) whose actionIDs begin at ((NUM_ACTIONBAR_PAGES - 1 + GetBonusBarOffset()) * NUM_ACTIONBAR_BUTTONS + 1). +function GetPossessInfo(index) end \ No newline at end of file diff --git a/api/GetPowerRegen.lua b/api/GetPowerRegen.lua new file mode 100644 index 0000000..95d3b75 --- /dev/null +++ b/api/GetPowerRegen.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number inactiveRegen +---@return number activeRegen +---Returns information about the player's mana/energy/etc regeneration rate. Contexts for inactiveRegen and activeRegen vary by power type. If the player (currently) uses mana, activeRegen refers to mana regeneration while casting (within five seconds of casting a spell) and inactiveRegen refers to mana regeneration while not casting (more than five seconds after casting a spell). For other power types, activeRegen refers to regeneration while in combat and inactiveRegen to regeneration outside of combat. Note that values returned can be negative: e.g. for rage and runic power users, inactiveRegen describes the rate of power decay while not in combat. +function GetPowerRegen() end \ No newline at end of file diff --git a/api/GetPrevCompleatedTutorial.lua b/api/GetPrevCompleatedTutorial.lua new file mode 100644 index 0000000..293b53e --- /dev/null +++ b/api/GetPrevCompleatedTutorial.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetPrevCompleatedTutorial() end \ No newline at end of file diff --git a/api/GetPreviousAchievement.lua b/api/GetPreviousAchievement.lua new file mode 100644 index 0000000..4f8cc73 --- /dev/null +++ b/api/GetPreviousAchievement.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@return number previousID +---Returns the previous achievement for an achievement which is part of a series +function GetPreviousAchievement(id) end \ No newline at end of file diff --git a/api/GetPreviousArenaSeason.lua b/api/GetPreviousArenaSeason.lua new file mode 100644 index 0000000..c710c08 --- /dev/null +++ b/api/GetPreviousArenaSeason.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number season +---Returns a number identifying the previous arena season. New arena seasons begin every few months, resetting team rankings and providing new rewards. +function GetPreviousArenaSeason() end \ No newline at end of file diff --git a/api/GetProfessionInfo.lua b/api/GetProfessionInfo.lua new file mode 100644 index 0000000..04cce4f --- /dev/null +++ b/api/GetProfessionInfo.lua @@ -0,0 +1,15 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---@return string texture +---@return number rank +---@return number maxRank +---@return number numSpells +---@return number spelloffset +---@return number skillLine +---@return number rankModifier +---@return number specializationIndex +---@return number specializationOffset +---Returns details on a profession from its index including name, icon, and skill level +function GetProfessionInfo(index) end \ No newline at end of file diff --git a/api/GetProfessions.lua b/api/GetProfessions.lua new file mode 100644 index 0000000..40502ac --- /dev/null +++ b/api/GetProfessions.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number prof1 +---@return number prof2 +---@return number archaeology +---@return number fishing +---@return number cooking +---@return number firstAid +---Returns indices of all of the current character's professions. The indices returned can be passed into the GetProfessionInfo() function. The indices are not fixed and can change when a character learns or unlearns a profession. If you do not have one of the skills the value returned will be nil. +function GetProfessions() end \ No newline at end of file diff --git a/api/GetProgressText.lua b/api/GetProgressText.lua new file mode 100644 index 0000000..b1ef5f9 --- /dev/null +++ b/api/GetProgressText.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string text +---Returns the quest progress text presented by a questgiver. Only valid when the questgiver UI is showing the progress stage of a quest dialog (between the QUEST_PROGRESS and QUEST_FINISHED events); otherwise may return the empty string or a value from the most recently displayed quest. +function GetProgressText() end \ No newline at end of file diff --git a/api/GetPvpPowerDamage.lua b/api/GetPvpPowerDamage.lua new file mode 100644 index 0000000..6570cf6 --- /dev/null +++ b/api/GetPvpPowerDamage.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetPvpPowerDamage() end \ No newline at end of file diff --git a/api/GetPvpPowerHealing.lua b/api/GetPvpPowerHealing.lua new file mode 100644 index 0000000..f5b3b82 --- /dev/null +++ b/api/GetPvpPowerHealing.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetPvpPowerHealing() end \ No newline at end of file diff --git a/api/GetQuestBackgroundMaterial.lua b/api/GetQuestBackgroundMaterial.lua new file mode 100644 index 0000000..f8299bd --- /dev/null +++ b/api/GetQuestBackgroundMaterial.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return Stone material +---@return Bronze +---@return Marble +---@return Parchment +---@return Silver +---@return Stone +---Returns background display style information for a questgiver dialog. The value returned can be used to look up background textures and text colors for display: Background textures displayed in the default UI can be found by prepending "Interface\\ItemTextFrame\\ItemText-" and appending "-TopLeft", "-TopRight", "-BotLeft", "-BotRight" to the material string (e.g. "Interface\\ItemTextFrame\\ItemText-Stone-TopLeft"). Colors for body and title text can be found by calling GetMaterialTextColors(material) (a Lua function implemented in the Blizzard UI). In cases where this function returns nil, the default UI uses the colors and textures for "Parchment". +function GetQuestBackgroundMaterial() end \ No newline at end of file diff --git a/api/GetQuestChoiceInfo.lua b/api/GetQuestChoiceInfo.lua new file mode 100644 index 0000000..5cf8b12 --- /dev/null +++ b/api/GetQuestChoiceInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetQuestChoiceInfo() end \ No newline at end of file diff --git a/api/GetQuestChoiceOptionInfo.lua b/api/GetQuestChoiceOptionInfo.lua new file mode 100644 index 0000000..4025277 --- /dev/null +++ b/api/GetQuestChoiceOptionInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetQuestChoiceOptionInfo() end \ No newline at end of file diff --git a/api/GetQuestChoiceRewardCurrency.lua b/api/GetQuestChoiceRewardCurrency.lua new file mode 100644 index 0000000..709cb31 --- /dev/null +++ b/api/GetQuestChoiceRewardCurrency.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetQuestChoiceRewardCurrency() end \ No newline at end of file diff --git a/api/GetQuestChoiceRewardFaction.lua b/api/GetQuestChoiceRewardFaction.lua new file mode 100644 index 0000000..f339236 --- /dev/null +++ b/api/GetQuestChoiceRewardFaction.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetQuestChoiceRewardFaction() end \ No newline at end of file diff --git a/api/GetQuestChoiceRewardInfo.lua b/api/GetQuestChoiceRewardInfo.lua new file mode 100644 index 0000000..82304ec --- /dev/null +++ b/api/GetQuestChoiceRewardInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetQuestChoiceRewardInfo() end \ No newline at end of file diff --git a/api/GetQuestChoiceRewardItem.lua b/api/GetQuestChoiceRewardItem.lua new file mode 100644 index 0000000..0ff49c1 --- /dev/null +++ b/api/GetQuestChoiceRewardItem.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetQuestChoiceRewardItem() end \ No newline at end of file diff --git a/api/GetQuestCurrencyInfo.lua b/api/GetQuestCurrencyInfo.lua new file mode 100644 index 0000000..14df00a --- /dev/null +++ b/api/GetQuestCurrencyInfo.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param type reward +---@param required +---@param reward +---@param index integer +---@return string name +---@return string texture +---@return integer amount +---Returns information about currency rewarded/required for quest completion +function GetQuestCurrencyInfo(type, required, reward, index) end \ No newline at end of file diff --git a/api/GetQuestDifficultyColor.lua b/api/GetQuestDifficultyColor.lua new file mode 100644 index 0000000..0206946 --- /dev/null +++ b/api/GetQuestDifficultyColor.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param level number +---@return table color +---Returns a table of color values indicating the difficulty of a quest's level as compared to the player's +function GetQuestDifficultyColor(level) end \ No newline at end of file diff --git a/api/GetQuestFactionGroup.lua b/api/GetQuestFactionGroup.lua new file mode 100644 index 0000000..7ac5010 --- /dev/null +++ b/api/GetQuestFactionGroup.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetQuestFactionGroup() end \ No newline at end of file diff --git a/api/GetQuestGreenRange.lua b/api/GetQuestGreenRange.lua new file mode 100644 index 0000000..e278d66 --- /dev/null +++ b/api/GetQuestGreenRange.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number range +---Returns the level range in which a quest below the player's level still rewards XP. If a quest's level is up to range levels below the player's level, the quest is considered easy but still rewards experience points upon completion; these quests are colored green in the default UI's quest log. (Quests more than range levels below the player's are colored gray in the default UI and reward no XP.) +function GetQuestGreenRange() end \ No newline at end of file diff --git a/api/GetQuestID.lua b/api/GetQuestID.lua new file mode 100644 index 0000000..9bc75ff --- /dev/null +++ b/api/GetQuestID.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number questID +---Returns the internal ID of a quest featured in the currently active NPC dialogue (available after a QUEST_DETAIL event). Returns 0 if no quest dialogue happened in the current session yet. Warning: returns the last offered quest ID - it will keep returning the last value even out of any QUEST_DETAIL dialogue context, until a new quest is mentioned. +function GetQuestID() end \ No newline at end of file diff --git a/api/GetQuestIndexForTimer.lua b/api/GetQuestIndexForTimer.lua new file mode 100644 index 0000000..46c058d --- /dev/null +++ b/api/GetQuestIndexForTimer.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number questIndex +---Returns the quest log index of a timed quest's timer +function GetQuestIndexForTimer(index) end \ No newline at end of file diff --git a/api/GetQuestIndexForWatch.lua b/api/GetQuestIndexForWatch.lua new file mode 100644 index 0000000..3e1021a --- /dev/null +++ b/api/GetQuestIndexForWatch.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number questIndex +---Returns the quest log index of a quest in the objectives tracker +function GetQuestIndexForWatch(index) end \ No newline at end of file diff --git a/api/GetQuestItemInfo.lua b/api/GetQuestItemInfo.lua new file mode 100644 index 0000000..1409562 --- /dev/null +++ b/api/GetQuestItemInfo.lua @@ -0,0 +1,21 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param type reward +---@param choice +---@param required +---@param reward +---@param index number +---@return string name +---@return string texture +---@return number numItems +---@return 6 quality +---@return 0 +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---@return 5 +---@return 6 +---@return 1nil isUsable +---Returns information about items in a questgiver dialog. Only valid when the questgiver UI is showing the accept/decline, progress, or completion stages of a quest dialog (between the QUEST_DETAIL and QUEST_FINISHED, QUEST_PROGRESS and QUEST_FINISHED, or QUEST_COMPLETE and QUEST_FINISHED events); otherwise may return empty values or those from the most recently displayed quest. +function GetQuestItemInfo(type, choice, required, reward, index) end \ No newline at end of file diff --git a/api/GetQuestItemLink.lua b/api/GetQuestItemLink.lua new file mode 100644 index 0000000..1cb4c35 --- /dev/null +++ b/api/GetQuestItemLink.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemType reward +---@param choice +---@param required +---@param reward +---@param index number +---@return string link +---Returns a hyperlink for an item in a questgiver dialog. Only valid when the questgiver UI is showing the accept/decline, progress, or completion stages of a quest dialog (between the QUEST_DETAIL and QUEST_FINISHED, QUEST_PROGRESS and QUEST_FINISHED, or QUEST_COMPLETE and QUEST_FINISHED events); otherwise may return nil or a value from the most recently displayed quest. +function GetQuestItemLink(itemType, choice, required, reward, index) end \ No newline at end of file diff --git a/api/GetQuestLink.lua b/api/GetQuestLink.lua new file mode 100644 index 0000000..82a0d61 --- /dev/null +++ b/api/GetQuestLink.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param questID number +---@return string link +---Returns a hyperlink of a specific quest +function GetQuestLink(questID) end \ No newline at end of file diff --git a/api/GetQuestLogChoiceInfo.lua b/api/GetQuestLogChoiceInfo.lua new file mode 100644 index 0000000..a40df91 --- /dev/null +++ b/api/GetQuestLogChoiceInfo.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---@return string texture +---@return number numItems +---@return number quality +---@return nil isUsable +---@return number itemID +---Returns information about available item rewards for the selected quest in the quest log. This function refers to quest rewards for which the player is allowed to choose one item from among several; for items always awarded upon quest completion, see GetQuestLogRewardInfo. +function GetQuestLogChoiceInfo(index) end \ No newline at end of file diff --git a/api/GetQuestLogCompletionText.lua b/api/GetQuestLogCompletionText.lua new file mode 100644 index 0000000..7925b58 --- /dev/null +++ b/api/GetQuestLogCompletionText.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string completionText +---Returns the completion text for the selected quest in the quest log. Completion text usually includes instructions on to whom and where to hand in the quest once it has been completed. Example: "Return to William Pestle at Goldshire in Elwynn Forest." +function GetQuestLogCompletionText() end \ No newline at end of file diff --git a/api/GetQuestLogCriteriaSpell.lua b/api/GetQuestLogCriteriaSpell.lua new file mode 100644 index 0000000..2c68aa3 --- /dev/null +++ b/api/GetQuestLogCriteriaSpell.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number spellID +---@return string iconTexture +---@return boolean isLearned +---Returns the spell required by a quest, if any. It is currently known to return values for the learn spell quests. +function GetQuestLogCriteriaSpell(index) end \ No newline at end of file diff --git a/api/GetQuestLogGroupNum.lua b/api/GetQuestLogGroupNum.lua new file mode 100644 index 0000000..4c256d6 --- /dev/null +++ b/api/GetQuestLogGroupNum.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number suggestedGroup +---Returns the suggested group size for the selected quest in the quest log +function GetQuestLogGroupNum() end \ No newline at end of file diff --git a/api/GetQuestLogIndexByID.lua b/api/GetQuestLogIndexByID.lua new file mode 100644 index 0000000..6817559 --- /dev/null +++ b/api/GetQuestLogIndexByID.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@return number index +---Returns the index at which a particular quest ID can be found in the log. +function GetQuestLogIndexByID(id) end \ No newline at end of file diff --git a/api/GetQuestLogIsAutoComplete.lua b/api/GetQuestLogIsAutoComplete.lua new file mode 100644 index 0000000..4510b26 --- /dev/null +++ b/api/GetQuestLogIsAutoComplete.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetQuestLogIsAutoComplete() end \ No newline at end of file diff --git a/api/GetQuestLogItemDrop.lua b/api/GetQuestLogItemDrop.lua new file mode 100644 index 0000000..77a8e93 --- /dev/null +++ b/api/GetQuestLogItemDrop.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetQuestLogItemDrop() end \ No newline at end of file diff --git a/api/GetQuestLogItemLink.lua b/api/GetQuestLogItemLink.lua new file mode 100644 index 0000000..01bed62 --- /dev/null +++ b/api/GetQuestLogItemLink.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemType reward +---@param choice +---@param reward +---@param index number +---Returns a hyperlink for an item related to the selected quest in the quest log +function GetQuestLogItemLink(itemType, choice, reward, index) end \ No newline at end of file diff --git a/api/GetQuestLogLeaderBoard.lua b/api/GetQuestLogLeaderBoard.lua new file mode 100644 index 0000000..9d0b346 --- /dev/null +++ b/api/GetQuestLogLeaderBoard.lua @@ -0,0 +1,14 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param objective number +---@param questIndex number +---@return string text +---@return reputation type +---@return event +---@return item +---@return monster +---@return object +---@return reputation +---@return 1nil finished +---Returns information about objectives for a quest in the quest log +function GetQuestLogLeaderBoard(objective, questIndex) end \ No newline at end of file diff --git a/api/GetQuestLogPortraitGiver.lua b/api/GetQuestLogPortraitGiver.lua new file mode 100644 index 0000000..4b6939c --- /dev/null +++ b/api/GetQuestLogPortraitGiver.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number questPortrait +---@return string questPortraitText +---@return string questPortraitName +---Returns quest-related NPC info for portrait display. Queries the currently selected quest in the quest log. +function GetQuestLogPortraitGiver() end \ No newline at end of file diff --git a/api/GetQuestLogPortraitTurnIn.lua b/api/GetQuestLogPortraitTurnIn.lua new file mode 100644 index 0000000..0eebc71 --- /dev/null +++ b/api/GetQuestLogPortraitTurnIn.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number questPortrait +---@return string questPortraitText +---@return string questPortraitName +---Returns quest-related NPC info for portrait display +function GetQuestLogPortraitTurnIn() end \ No newline at end of file diff --git a/api/GetQuestLogPushable.lua b/api/GetQuestLogPushable.lua new file mode 100644 index 0000000..6e6388a --- /dev/null +++ b/api/GetQuestLogPushable.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil shareable +---Return whether the selected quest in the quest log can be shared to party members +function GetQuestLogPushable() end \ No newline at end of file diff --git a/api/GetQuestLogQuestText.lua b/api/GetQuestLogQuestText.lua new file mode 100644 index 0000000..ffbed60 --- /dev/null +++ b/api/GetQuestLogQuestText.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string questDescription +---@return string questObjectives +---Returns the description and objective text for the selected quest in the quest log +function GetQuestLogQuestText() end \ No newline at end of file diff --git a/api/GetQuestLogQuestType.lua b/api/GetQuestLogQuestType.lua new file mode 100644 index 0000000..d254b3e --- /dev/null +++ b/api/GetQuestLogQuestType.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetQuestLogQuestType() end \ No newline at end of file diff --git a/api/GetQuestLogRequiredMoney.lua b/api/GetQuestLogRequiredMoney.lua new file mode 100644 index 0000000..ae84610 --- /dev/null +++ b/api/GetQuestLogRequiredMoney.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number money +---Returns the amount of money required for the selected quest in the quest log +function GetQuestLogRequiredMoney() end \ No newline at end of file diff --git a/api/GetQuestLogRewardCurrencyInfo.lua b/api/GetQuestLogRewardCurrencyInfo.lua new file mode 100644 index 0000000..05a2c26 --- /dev/null +++ b/api/GetQuestLogRewardCurrencyInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetQuestLogRewardCurrencyInfo() end \ No newline at end of file diff --git a/api/GetQuestLogRewardFactionInfo.lua b/api/GetQuestLogRewardFactionInfo.lua new file mode 100644 index 0000000..1e8a88b --- /dev/null +++ b/api/GetQuestLogRewardFactionInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetQuestLogRewardFactionInfo() end \ No newline at end of file diff --git a/api/GetQuestLogRewardInfo.lua b/api/GetQuestLogRewardInfo.lua new file mode 100644 index 0000000..5a61415 --- /dev/null +++ b/api/GetQuestLogRewardInfo.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---@return string texture +---@return number numItems +---@return number quality +---@return 1nil isUsable +---Returns information about item rewards for the selected quest in the quest log. This function refers to items always awarded upon quest completion; for quest rewards for which the player is allowed to choose one item from among several, see GetQuestLogChoiceInfo. +function GetQuestLogRewardInfo(index) end \ No newline at end of file diff --git a/api/GetQuestLogRewardMoney.lua b/api/GetQuestLogRewardMoney.lua new file mode 100644 index 0000000..685a023 --- /dev/null +++ b/api/GetQuestLogRewardMoney.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number money +---Returns the money reward for the selected quest in the quest log +function GetQuestLogRewardMoney() end \ No newline at end of file diff --git a/api/GetQuestLogRewardSkillPoints.lua b/api/GetQuestLogRewardSkillPoints.lua new file mode 100644 index 0000000..4c1bfb0 --- /dev/null +++ b/api/GetQuestLogRewardSkillPoints.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string skillName +---@return string icon +---@return number points +---Returns skill point reward info for the selected quest in the quest log +function GetQuestLogRewardSkillPoints() end \ No newline at end of file diff --git a/api/GetQuestLogRewardSpell.lua b/api/GetQuestLogRewardSpell.lua new file mode 100644 index 0000000..00a38f5 --- /dev/null +++ b/api/GetQuestLogRewardSpell.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string texture +---@return string name +---@return 1nil isTradeskillSpell +---@return 1nil isSpellLearned +---Returns information about the spell reward for the selected quest in the quest log. If both isTradeskillSpell and isSpellLearned are nil, the reward is a spell cast upon the player. +function GetQuestLogRewardSpell() end \ No newline at end of file diff --git a/api/GetQuestLogRewardTalents.lua b/api/GetQuestLogRewardTalents.lua new file mode 100644 index 0000000..cd3bc3a --- /dev/null +++ b/api/GetQuestLogRewardTalents.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number talents +---Returns the talent point reward for the selected quest in the quest log. Returns 0 for quests which do not award talent points. (Very few quests award talent points; currently this functionality is only used within the Death Knight starting experience.) +function GetQuestLogRewardTalents() end \ No newline at end of file diff --git a/api/GetQuestLogRewardTitle.lua b/api/GetQuestLogRewardTitle.lua new file mode 100644 index 0000000..377efae --- /dev/null +++ b/api/GetQuestLogRewardTitle.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string title +---Returns the title reward for the selected quest in the quest log. Returns nil if no title is awarded or if no quest is selected. +function GetQuestLogRewardTitle() end \ No newline at end of file diff --git a/api/GetQuestLogRewardXP.lua b/api/GetQuestLogRewardXP.lua new file mode 100644 index 0000000..01fa624 --- /dev/null +++ b/api/GetQuestLogRewardXP.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number experience +---Returns the experience reward at the player's level for the selected quest in the quest log +function GetQuestLogRewardXP() end \ No newline at end of file diff --git a/api/GetQuestLogSelection.lua b/api/GetQuestLogSelection.lua new file mode 100644 index 0000000..34948c5 --- /dev/null +++ b/api/GetQuestLogSelection.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number questIndex +---Returns the index of the selected quest in the quest log +function GetQuestLogSelection() end \ No newline at end of file diff --git a/api/GetQuestLogSpecialItemCooldown.lua b/api/GetQuestLogSpecialItemCooldown.lua new file mode 100644 index 0000000..8b4708d --- /dev/null +++ b/api/GetQuestLogSpecialItemCooldown.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param questIndex number +---@return number start +---@return number duration +---@return number enable +---Returns cooldown information about an item associated with a current quest. Available for a number of quests which involve using an item (i.e. "Use the MacGuffin to summon and defeat the boss", "Use this saw to fell 12 trees", etc.) +function GetQuestLogSpecialItemCooldown(questIndex) end \ No newline at end of file diff --git a/api/GetQuestLogSpecialItemInfo.lua b/api/GetQuestLogSpecialItemInfo.lua new file mode 100644 index 0000000..ce13b33 --- /dev/null +++ b/api/GetQuestLogSpecialItemInfo.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param questIndex number +---@return string link +---@return string icon +---@return number charges +---Returns information about a usable item associated with a current quest. Available for a number of quests which involve using an item (i.e. "Use the MacGuffin to summon and defeat the boss", "Use this saw to fell 12 trees", etc.) +function GetQuestLogSpecialItemInfo(questIndex) end \ No newline at end of file diff --git a/api/GetQuestLogSpellLink.lua b/api/GetQuestLogSpellLink.lua new file mode 100644 index 0000000..6003875 --- /dev/null +++ b/api/GetQuestLogSpellLink.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string link +---Returns a hyperlink for a spell in the selected quest in the quest log +function GetQuestLogSpellLink() end \ No newline at end of file diff --git a/api/GetQuestLogTaskInfo.lua b/api/GetQuestLogTaskInfo.lua new file mode 100644 index 0000000..4807e15 --- /dev/null +++ b/api/GetQuestLogTaskInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetQuestLogTaskInfo() end \ No newline at end of file diff --git a/api/GetQuestLogTimeLeft.lua b/api/GetQuestLogTimeLeft.lua new file mode 100644 index 0000000..3a0a66d --- /dev/null +++ b/api/GetQuestLogTimeLeft.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number questTimer +---Returns time remaining for the selected quest in the quest log. If the selected quest is not timed, returns nil. +function GetQuestLogTimeLeft() end \ No newline at end of file diff --git a/api/GetQuestLogTitle.lua b/api/GetQuestLogTitle.lua new file mode 100644 index 0000000..b28c679 --- /dev/null +++ b/api/GetQuestLogTitle.lua @@ -0,0 +1,26 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param questIndex number +---@return string title +---@return number level +---@return number suggestedGroup +---@return boolean isHeader +---@return boolean isCollapsed +---@return nil isComplete +---@return -1 +---@return 1 +---@return nil +---@return LE_QUEST_FREQUENCY_WEEKLY frequency +---@return 1 +---@return LE_QUEST_FREQUENCY_DAILY +---@return LE_QUEST_FREQUENCY_WEEKLY +---@return number questID +---@return boolean startEvent +---@return boolean displayQuestID +---@return boolean isOnMap +---@return boolean hasLocalPOI +---@return boolean isTask +---@return boolean isStory +---@return boolean isHidden +---Returns information about an entry in the player's quest log +function GetQuestLogTitle(questIndex) end \ No newline at end of file diff --git a/api/GetQuestMoneyToGet.lua b/api/GetQuestMoneyToGet.lua new file mode 100644 index 0000000..3a42bb8 --- /dev/null +++ b/api/GetQuestMoneyToGet.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number money +---Returns the amount of money required to complete the quest presented by a questgiver. Usable following the QUEST_PROGRESS event in which it is determined whether the player can complete the quest. +function GetQuestMoneyToGet() end \ No newline at end of file diff --git a/api/GetQuestObjectiveInfo.lua b/api/GetQuestObjectiveInfo.lua new file mode 100644 index 0000000..666ede4 --- /dev/null +++ b/api/GetQuestObjectiveInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetQuestObjectiveInfo() end \ No newline at end of file diff --git a/api/GetQuestPOIBlobCount.lua b/api/GetQuestPOIBlobCount.lua new file mode 100644 index 0000000..38a131f --- /dev/null +++ b/api/GetQuestPOIBlobCount.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetQuestPOIBlobCount() end \ No newline at end of file diff --git a/api/GetQuestPOILeaderBoard.lua b/api/GetQuestPOILeaderBoard.lua new file mode 100644 index 0000000..5ed87d9 --- /dev/null +++ b/api/GetQuestPOILeaderBoard.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetQuestPOILeaderBoard() end \ No newline at end of file diff --git a/api/GetQuestPOIWorldEffectInfo.lua b/api/GetQuestPOIWorldEffectInfo.lua new file mode 100644 index 0000000..e73626c --- /dev/null +++ b/api/GetQuestPOIWorldEffectInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetQuestPOIWorldEffectInfo() end \ No newline at end of file diff --git a/api/GetQuestPOIs.lua b/api/GetQuestPOIs.lua new file mode 100644 index 0000000..9acd43b --- /dev/null +++ b/api/GetQuestPOIs.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetQuestPOIs() end \ No newline at end of file diff --git a/api/GetQuestPortraitGiver.lua b/api/GetQuestPortraitGiver.lua new file mode 100644 index 0000000..c13a686 --- /dev/null +++ b/api/GetQuestPortraitGiver.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number questPortrait +---@return string questPortraitText +---@return string questPortraitName +---Returns quest-related NPC info for portrait display. Queries the quest currently being accepted. +function GetQuestPortraitGiver() end \ No newline at end of file diff --git a/api/GetQuestPortraitTurnIn.lua b/api/GetQuestPortraitTurnIn.lua new file mode 100644 index 0000000..ade3deb --- /dev/null +++ b/api/GetQuestPortraitTurnIn.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number questPortrait +---@return string questPortraitText +---@return string questPortraitName +---Returns quest-related NPC info for portrait display. Queries the quest currently being turned in. +function GetQuestPortraitTurnIn() end \ No newline at end of file diff --git a/api/GetQuestProgressBarPercent.lua b/api/GetQuestProgressBarPercent.lua new file mode 100644 index 0000000..0e24daa --- /dev/null +++ b/api/GetQuestProgressBarPercent.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param questID number +---@return number percent +---Returns the completion percent of a quest with a bar. Such as apexiszones. +function GetQuestProgressBarPercent(questID) end \ No newline at end of file diff --git a/api/GetQuestResetTime.lua b/api/GetQuestResetTime.lua new file mode 100644 index 0000000..f4c8761 --- /dev/null +++ b/api/GetQuestResetTime.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number time +---Returns the amount of time remaining until the daily quest period resets +function GetQuestResetTime() end \ No newline at end of file diff --git a/api/GetQuestReward.lua b/api/GetQuestReward.lua new file mode 100644 index 0000000..3b8bc34 --- /dev/null +++ b/api/GetQuestReward.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param choice number +---Finishes turning in a quest to a questgiver, selecting an item reward if applicable. Usable following the QUEST_COMPLETE event in which the questgiver presents the player with rewards. +function GetQuestReward(choice) end \ No newline at end of file diff --git a/api/GetQuestSortIndex.lua b/api/GetQuestSortIndex.lua new file mode 100644 index 0000000..95df75f --- /dev/null +++ b/api/GetQuestSortIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetQuestSortIndex() end \ No newline at end of file diff --git a/api/GetQuestSpellLink.lua b/api/GetQuestSpellLink.lua new file mode 100644 index 0000000..57ab700 --- /dev/null +++ b/api/GetQuestSpellLink.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string link +---Returns a hyperlink for a spell in a questgiver dialog. Only valid when the questgiver UI is showing the accept/decline, progress, or completion stages of a quest dialog (between the QUEST_DETAIL and QUEST_FINISHED, QUEST_PROGRESS and QUEST_FINISHED, or QUEST_COMPLETE and QUEST_FINISHED events); otherwise may return empty values or those from the most recently displayed quest. +function GetQuestSpellLink() end \ No newline at end of file diff --git a/api/GetQuestTagInfo.lua b/api/GetQuestTagInfo.lua new file mode 100644 index 0000000..07c2e0b --- /dev/null +++ b/api/GetQuestTagInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetQuestTagInfo() end \ No newline at end of file diff --git a/api/GetQuestText.lua b/api/GetQuestText.lua new file mode 100644 index 0000000..a0e3e73 --- /dev/null +++ b/api/GetQuestText.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string text +---Returns the text for the quest offered by a questgiver. Only valid when the questgiver UI is showing the accept/decline stage of a quest dialog (between the QUEST_COMPLETE and QUEST_FINISHED events); otherwise may return the empty string or a value from the most recently displayed quest. +function GetQuestText() end \ No newline at end of file diff --git a/api/GetQuestTimers.lua b/api/GetQuestTimers.lua new file mode 100644 index 0000000..417fee9 --- /dev/null +++ b/api/GetQuestTimers.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number ... +---Returns a list of the times remaining for any active timed quests +function GetQuestTimers() end \ No newline at end of file diff --git a/api/GetQuestWatchIndex.lua b/api/GetQuestWatchIndex.lua new file mode 100644 index 0000000..d7fca6b --- /dev/null +++ b/api/GetQuestWatchIndex.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param questLogIndex number +---@return number questWatchIndex +---Returns the quest watch (objective tracker) index of a quest in the quest log +function GetQuestWatchIndex(questLogIndex) end \ No newline at end of file diff --git a/api/GetQuestWatchInfo.lua b/api/GetQuestWatchInfo.lua new file mode 100644 index 0000000..eb06982 --- /dev/null +++ b/api/GetQuestWatchInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetQuestWatchInfo() end \ No newline at end of file diff --git a/api/GetQuestWorldMapAreaID.lua b/api/GetQuestWorldMapAreaID.lua new file mode 100644 index 0000000..eff3e48 --- /dev/null +++ b/api/GetQuestWorldMapAreaID.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param questID number +---@return number mapID +---@return number floorNumber +---Returns the map and floor for a given quest. The argument is the questID, not an index. To convert an index in the quest log use GetQuestLogTitle. +function GetQuestWorldMapAreaID(questID) end \ No newline at end of file diff --git a/api/GetQuestsCompleted.lua b/api/GetQuestsCompleted.lua new file mode 100644 index 0000000..c48e5f7 --- /dev/null +++ b/api/GetQuestsCompleted.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param questTbl table +---@return table completedQuests +---Gets a table containing the quests the player has completed. This function will only return data after QueryQuestsCompleted() has been called and the QUEST_QUERY_COMPLETE event has fired. The keys in the returned table are the numeric questIds, with a value of true for each set key. +function GetQuestsCompleted(questTbl) end \ No newline at end of file diff --git a/api/GetRFDungeonInfo.lua b/api/GetRFDungeonInfo.lua new file mode 100644 index 0000000..4681129 --- /dev/null +++ b/api/GetRFDungeonInfo.lua @@ -0,0 +1,23 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index GetNumRFDungeons() +---@return number dungeonID +---@return string name +---@return number typeID +---@return number subtype +---@return number minLevel +---@return number maxLevel +---@return number recLevel +---@return number minRecLevel +---@return number maxRecLevel +---@return integer expansionId +---@return integer groupId +---@return string texture +---@return number difficultyID +---@return number numPlayers +---@return string description +---@return boolean isHoliday +---@return number bonusRepAmount +---@return number minPlayers +---Returns information about the raidfinder instances available.. This has almost the same results as GetLFGDungeonInfo which takes dungeonID as its argument. +function GetRFDungeonInfo(index) end \ No newline at end of file diff --git a/api/GetRaidBuffInfo.lua b/api/GetRaidBuffInfo.lua new file mode 100644 index 0000000..6b567ab --- /dev/null +++ b/api/GetRaidBuffInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetRaidBuffInfo() end \ No newline at end of file diff --git a/api/GetRaidBuffTrayAuraInfo.lua b/api/GetRaidBuffTrayAuraInfo.lua new file mode 100644 index 0000000..6c8ff54 --- /dev/null +++ b/api/GetRaidBuffTrayAuraInfo.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param nil number +---@return string name +---@return string rank +---@return string texture +---@return number duration +---@return number expiration +---@return number spellId +---@return number slot +---Returns the active buff for a given raid buff category. As of 5.0, the default BuffFrames aggregate standard raid buffs. GetRaidBuffTrayAuraInfo is used to determine which buff category is active. Current raid buff categories are: RAID_BUFF_1 Stats RAID_BUFF_2 Stamina RAID_BUFF_3 Attack Power RAID_BUFF_4 Haste RAID_BUFF_5 Spell Power RAID_BUFF_6 Critical Strike RAID_BUFF_7 Mastery RAID_BUFF_8 Multistrike RAID_BUFF_9 Versatility The highest raid buff category number is indicated by NUM_LE_RAID_BUFF_TYPES. +function GetRaidBuffTrayAuraInfo(nil) end \ No newline at end of file diff --git a/api/GetRaidDifficultyID.lua b/api/GetRaidDifficultyID.lua new file mode 100644 index 0000000..809e2b0 --- /dev/null +++ b/api/GetRaidDifficultyID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetRaidDifficultyID() end \ No newline at end of file diff --git a/api/GetRaidProfileFlattenedOptions.lua b/api/GetRaidProfileFlattenedOptions.lua new file mode 100644 index 0000000..b370c41 --- /dev/null +++ b/api/GetRaidProfileFlattenedOptions.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetRaidProfileFlattenedOptions() end \ No newline at end of file diff --git a/api/GetRaidProfileName.lua b/api/GetRaidProfileName.lua new file mode 100644 index 0000000..04b8cec --- /dev/null +++ b/api/GetRaidProfileName.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetRaidProfileName() end \ No newline at end of file diff --git a/api/GetRaidProfileOption.lua b/api/GetRaidProfileOption.lua new file mode 100644 index 0000000..d18833b --- /dev/null +++ b/api/GetRaidProfileOption.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetRaidProfileOption() end \ No newline at end of file diff --git a/api/GetRaidProfileSavedPosition.lua b/api/GetRaidProfileSavedPosition.lua new file mode 100644 index 0000000..a28a801 --- /dev/null +++ b/api/GetRaidProfileSavedPosition.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetRaidProfileSavedPosition() end \ No newline at end of file diff --git a/api/GetRaidRosterInfo.lua b/api/GetRaidRosterInfo.lua new file mode 100644 index 0000000..9ef87f2 --- /dev/null +++ b/api/GetRaidRosterInfo.lua @@ -0,0 +1,21 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---@return 2 rank +---@return 0 +---@return 1 +---@return 2 +---@return number subgroup +---@return number level +---@return string class +---@return string fileName +---@return string zone +---@return 1nil online +---@return 1nil isDead +---@return MAINTANK role +---@return MAINASSIST +---@return MAINTANK +---@return 1nil isML +---Returns information about a member of the player's raid +function GetRaidRosterInfo(index) end \ No newline at end of file diff --git a/api/GetRaidTargetIndex.lua b/api/GetRaidTargetIndex.lua new file mode 100644 index 0000000..b5c886d --- /dev/null +++ b/api/GetRaidTargetIndex.lua @@ -0,0 +1,16 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return nil index +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---@return 5 +---@return 6 +---@return 7 +---@return 8 +---@return nil +---Returns the index of the raid target marker on a unit +function GetRaidTargetIndex(unit, name) end \ No newline at end of file diff --git a/api/GetRandomBGHonorCurrencyBonuses.lua b/api/GetRandomBGHonorCurrencyBonuses.lua new file mode 100644 index 0000000..68b2d84 --- /dev/null +++ b/api/GetRandomBGHonorCurrencyBonuses.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetRandomBGHonorCurrencyBonuses() end \ No newline at end of file diff --git a/api/GetRandomDungeonBestChoice.lua b/api/GetRandomDungeonBestChoice.lua new file mode 100644 index 0000000..190d1a4 --- /dev/null +++ b/api/GetRandomDungeonBestChoice.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Returns the dungeonID of the random dungeon group that provides the best loot for the player.. The dungeonID that is returned refers to an integer found in LFGDungeons.dbc. This function is normally used only for initialization of the LFGQueueFrame in FrameXML LFDFrame.lua. You can programatically join the suggested queue for a random dungeon for which your character is eligible. +function GetRandomDungeonBestChoice() end \ No newline at end of file diff --git a/api/GetRandomScenarioBestChoice.lua b/api/GetRandomScenarioBestChoice.lua new file mode 100644 index 0000000..b02333d --- /dev/null +++ b/api/GetRandomScenarioBestChoice.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetRandomScenarioBestChoice() end \ No newline at end of file diff --git a/api/GetRandomScenarioInfo.lua b/api/GetRandomScenarioInfo.lua new file mode 100644 index 0000000..7243268 --- /dev/null +++ b/api/GetRandomScenarioInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetRandomScenarioInfo() end \ No newline at end of file diff --git a/api/GetRangedCritChance.lua b/api/GetRangedCritChance.lua new file mode 100644 index 0000000..305ede7 --- /dev/null +++ b/api/GetRangedCritChance.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number critChance +---Returns the player's ranged critical strike chance +function GetRangedCritChance() end \ No newline at end of file diff --git a/api/GetRangedHaste.lua b/api/GetRangedHaste.lua new file mode 100644 index 0000000..9401ecd --- /dev/null +++ b/api/GetRangedHaste.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number haste +---Returns information about the player's ranged haste +function GetRangedHaste() end \ No newline at end of file diff --git a/api/GetRatedBattleGroundInfo.lua b/api/GetRatedBattleGroundInfo.lua new file mode 100644 index 0000000..99d42bf --- /dev/null +++ b/api/GetRatedBattleGroundInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetRatedBattleGroundInfo() end \ No newline at end of file diff --git a/api/GetReadyCheckStatus.lua b/api/GetReadyCheckStatus.lua new file mode 100644 index 0000000..c84a82e --- /dev/null +++ b/api/GetReadyCheckStatus.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return nil status +---@return "notready" +---@return "ready" +---@return "waiting" +---@return nil +---Returns a unit's status during a ready check. Returns nil for all units unless the player is the party/raid leader or a raid assistant. +function GetReadyCheckStatus(unit) end \ No newline at end of file diff --git a/api/GetReadyCheckTimeLeft.lua b/api/GetReadyCheckTimeLeft.lua new file mode 100644 index 0000000..567c7f9 --- /dev/null +++ b/api/GetReadyCheckTimeLeft.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number timeLeft +---Returns the amount of time left on the current ready check. Returns 0 if no ready check is in progress. +function GetReadyCheckTimeLeft() end \ No newline at end of file diff --git a/api/GetReagentBankCost.lua b/api/GetReagentBankCost.lua new file mode 100644 index 0000000..33baa90 --- /dev/null +++ b/api/GetReagentBankCost.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number cost +---Returns the cost of the reagent bank tab +function GetReagentBankCost() end \ No newline at end of file diff --git a/api/GetRealZoneText.lua b/api/GetRealZoneText.lua new file mode 100644 index 0000000..e61f633 --- /dev/null +++ b/api/GetRealZoneText.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string zoneName +---Returns the "official" name of the zone or instance in which the player is located. This name matches that seen in the Who, Guild, and Friends UIs when reporting character locations. It may differ from those the default UI displays in other locations (GetZoneText() and GetMinimapZoneText()), especially if the player is in an instance: e.g. this function returns "The Stockade" when the others return "Stormwind Stockade". +function GetRealZoneText() end \ No newline at end of file diff --git a/api/GetRealmName.lua b/api/GetRealmName.lua new file mode 100644 index 0000000..844f502 --- /dev/null +++ b/api/GetRealmName.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string realm +---Returns the name of the player's realm (server name) +function GetRealmName() end \ No newline at end of file diff --git a/api/GetRecruitingGuildInfo.lua b/api/GetRecruitingGuildInfo.lua new file mode 100644 index 0000000..0daef3f --- /dev/null +++ b/api/GetRecruitingGuildInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetRecruitingGuildInfo() end \ No newline at end of file diff --git a/api/GetRecruitingGuildSelection.lua b/api/GetRecruitingGuildSelection.lua new file mode 100644 index 0000000..1408834 --- /dev/null +++ b/api/GetRecruitingGuildSelection.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetRecruitingGuildSelection() end \ No newline at end of file diff --git a/api/GetRecruitingGuildSettings.lua b/api/GetRecruitingGuildSettings.lua new file mode 100644 index 0000000..8babce2 --- /dev/null +++ b/api/GetRecruitingGuildSettings.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetRecruitingGuildSettings() end \ No newline at end of file diff --git a/api/GetRecruitingGuildTabardInfo.lua b/api/GetRecruitingGuildTabardInfo.lua new file mode 100644 index 0000000..2733476 --- /dev/null +++ b/api/GetRecruitingGuildTabardInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetRecruitingGuildTabardInfo() end \ No newline at end of file diff --git a/api/GetRefreshRates.lua b/api/GetRefreshRates.lua new file mode 100644 index 0000000..8f08160 --- /dev/null +++ b/api/GetRefreshRates.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number ... +---Returns a list of available screen refresh rates. The current refresh rate can be found in the gxRefresh CVar. +function GetRefreshRates() end \ No newline at end of file diff --git a/api/GetRegisteredAddonMessagePrefixes.lua b/api/GetRegisteredAddonMessagePrefixes.lua new file mode 100644 index 0000000..b068f61 --- /dev/null +++ b/api/GetRegisteredAddonMessagePrefixes.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param prefixTable table +---@return table registeredPrefixes +---Returns a table containing all addon message prefixes that have been registered +function GetRegisteredAddonMessagePrefixes(prefixTable) end \ No newline at end of file diff --git a/api/GetReleaseTimeRemaining.lua b/api/GetReleaseTimeRemaining.lua new file mode 100644 index 0000000..6b454b8 --- /dev/null +++ b/api/GetReleaseTimeRemaining.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number timeleft +---Returns the amount of time remaining until the player's spirit is automatically released when dead. Returns -1 if the player died in a dungeon or raid instance; in such cases, the player's spirit will not be released automatically (see RepopMe() to release manually). +function GetReleaseTimeRemaining() end \ No newline at end of file diff --git a/api/GetRepairAllCost.lua b/api/GetRepairAllCost.lua new file mode 100644 index 0000000..8e0f401 --- /dev/null +++ b/api/GetRepairAllCost.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number repairAllCost +---@return 1nil canRepair +---Returns the cost to repair all of the player's damaged items. Returns 0, nil if none of the player's items are damaged. Only returns valid data while interacting with a vendor which allows repairs (i.e. for whom CanMerchantRepair() returns 1). +function GetRepairAllCost() end \ No newline at end of file diff --git a/api/GetResSicknessDuration.lua b/api/GetResSicknessDuration.lua new file mode 100644 index 0000000..ad02ae2 --- /dev/null +++ b/api/GetResSicknessDuration.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string resSicknessTime +---Returns the duration of resurrection sickness at the player's current level. Returns nil for players under level 10, who are allowed to resurrect at a spirit healer without suffering resurrection sickness. +function GetResSicknessDuration() end \ No newline at end of file diff --git a/api/GetRestState.lua b/api/GetRestState.lua new file mode 100644 index 0000000..c3f102a --- /dev/null +++ b/api/GetRestState.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 4 state +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---@return string name +---@return number multiplier +---Returns the player's current rest state +function GetRestState() end \ No newline at end of file diff --git a/api/GetRestrictedAccountData.lua b/api/GetRestrictedAccountData.lua new file mode 100644 index 0000000..9376cb7 --- /dev/null +++ b/api/GetRestrictedAccountData.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetRestrictedAccountData() end \ No newline at end of file diff --git a/api/GetRewardMoney.lua b/api/GetRewardMoney.lua new file mode 100644 index 0000000..2cca528 --- /dev/null +++ b/api/GetRewardMoney.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number money +---Returns the amount of money awarded when completing a quest.   Only valid when the questgiver UI is showing the accept/decline or completion stages of a quest dialog (between the QUEST_DETAIL and QUEST_FINISHED events, or between the QUEST_COMPLETE and QUEST_FINISHED events); otherwise may return zero or a value from the most recently displayed quest. +function GetRewardMoney() end \ No newline at end of file diff --git a/api/GetRewardNumSkillUps.lua b/api/GetRewardNumSkillUps.lua new file mode 100644 index 0000000..edb2a98 --- /dev/null +++ b/api/GetRewardNumSkillUps.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetRewardNumSkillUps() end \ No newline at end of file diff --git a/api/GetRewardSkillLineID.lua b/api/GetRewardSkillLineID.lua new file mode 100644 index 0000000..785e37a --- /dev/null +++ b/api/GetRewardSkillLineID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetRewardSkillLineID() end \ No newline at end of file diff --git a/api/GetRewardSkillPoints.lua b/api/GetRewardSkillPoints.lua new file mode 100644 index 0000000..c7af54a --- /dev/null +++ b/api/GetRewardSkillPoints.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetRewardSkillPoints() end \ No newline at end of file diff --git a/api/GetRewardSpell.lua b/api/GetRewardSpell.lua new file mode 100644 index 0000000..438c19f --- /dev/null +++ b/api/GetRewardSpell.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string texture +---@return string name +---@return 1nil isTradeskillSpell +---@return 1nil isSpellLearned +---Returns information about a spell awarded when completing a quest. Only valid when the questgiver UI is showing the accept/decline or completion stages of a quest dialog (between the QUEST_DETAIL and QUEST_FINISHED events, or between the QUEST_COMPLETE and QUEST_FINISHED events); otherwise may return zero or values from the most recently displayed quest. If both isTradeskillSpell and isSpellLearned are nil, the reward is a spell cast upon the player. +function GetRewardSpell() end \ No newline at end of file diff --git a/api/GetRewardTalents.lua b/api/GetRewardTalents.lua new file mode 100644 index 0000000..b2a2f7b --- /dev/null +++ b/api/GetRewardTalents.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number talents +---Returns the talent points awarded when completing a quest. Only valid when the questgiver UI is showing the accept/decline or completion stages of a quest dialog (between the QUEST_DETAIL and QUEST_FINISHED events, or between the QUEST_COMPLETE and QUEST_FINISHED events); otherwise may return zero or a value from the most recently displayed quest. (Very few quests award talent points; currently this functionality is only used within the Death Knight starting experience.) +function GetRewardTalents() end \ No newline at end of file diff --git a/api/GetRewardText.lua b/api/GetRewardText.lua new file mode 100644 index 0000000..e72c58e --- /dev/null +++ b/api/GetRewardText.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string text +---Returns questgiver dialog to be displayed when completing a quest. Only valid when the questgiver UI is showing the completion stage of a quest dialog (between the QUEST_COMPLETE and QUEST_FINISHED events); otherwise may return the empty string or a value from the most recently displayed quest. +function GetRewardText() end \ No newline at end of file diff --git a/api/GetRewardTitle.lua b/api/GetRewardTitle.lua new file mode 100644 index 0000000..8c14203 --- /dev/null +++ b/api/GetRewardTitle.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string title +---Returns the title awarded when completing a quest. Only valid when the questgiver UI is showing the accept/decline or completion stages of a quest dialog (between the QUEST_DETAIL and QUEST_FINISHED events, or between the QUEST_COMPLETE and QUEST_FINISHED events); otherwise may return nil or a value from the most recently displayed quest. +function GetRewardTitle() end \ No newline at end of file diff --git a/api/GetRewardXP.lua b/api/GetRewardXP.lua new file mode 100644 index 0000000..281c06d --- /dev/null +++ b/api/GetRewardXP.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number amount +---Returns the experience awarded when completing a quest. Only valid when the questgiver UI is showing the accept/decline or completion stages of a quest dialog (between the QUEST_DETAIL and QUEST_FINISHED events, or between the QUEST_COMPLETE and QUEST_FINISHED events); otherwise may return nil or a value from the most recently displayed quest. +function GetRewardXP() end \ No newline at end of file diff --git a/api/GetRuneCooldown.lua b/api/GetRuneCooldown.lua new file mode 100644 index 0000000..95e6342 --- /dev/null +++ b/api/GetRuneCooldown.lua @@ -0,0 +1,14 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot 6 +---@param 1 +---@param 2 +---@param 3 +---@param 4 +---@param 5 +---@param 6 +---@return number start +---@return number duration +---@return boolean runeReady +---Returns cooldown information about one of the player's rune resources. Note the placement of runes 3-4 (normally Unholy) and 5-6 (normally Frost) are reversed in the default UI. Also note the behavior of returned values differs slightly from most other GetXYZCooldown-style functions. +function GetRuneCooldown(slot, 1, 2, 3, 4, 5, 6) end \ No newline at end of file diff --git a/api/GetRuneCount.lua b/api/GetRuneCount.lua new file mode 100644 index 0000000..0ec24e9 --- /dev/null +++ b/api/GetRuneCount.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot 6 +---@param 1 +---@param 2 +---@param 3 +---@param 4 +---@param 5 +---@param 6 +---@return number count +---Returns the number of available rune resources in one of the player's rune slots. Returns 1 if a rune is ready and 0 if a rune is on cooldown. +function GetRuneCount(slot, 1, 2, 3, 4, 5, 6) end \ No newline at end of file diff --git a/api/GetRuneType.lua b/api/GetRuneType.lua new file mode 100644 index 0000000..67c61ba --- /dev/null +++ b/api/GetRuneType.lua @@ -0,0 +1,16 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot 6 +---@param 1 +---@param 2 +---@param 3 +---@param 4 +---@param 5 +---@param 6 +---@return 4 runeType +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---Returns the type of one of the player's rune resources. Note the placement of runes 3-4 (normally Unholy) and 5-6 (normally Frost) are reversed in the default UI. +function GetRuneType(slot, 1, 2, 3, 4, 5, 6) end \ No newline at end of file diff --git a/api/GetRunningMacro.lua b/api/GetRunningMacro.lua new file mode 100644 index 0000000..516eaaa --- /dev/null +++ b/api/GetRunningMacro.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number index +---Returns the index of the currently running macro. +function GetRunningMacro() end \ No newline at end of file diff --git a/api/GetRunningMacroButton.lua b/api/GetRunningMacroButton.lua new file mode 100644 index 0000000..53331cb --- /dev/null +++ b/api/GetRunningMacroButton.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return RightButton button +---@return Button4 +---@return Button5 +---@return LeftButton +---@return MiddleButton +---@return RightButton +---Returns the mouse button that was used to activate the running macro +function GetRunningMacroButton() end \ No newline at end of file diff --git a/api/GetSavedInstanceChatLink.lua b/api/GetSavedInstanceChatLink.lua new file mode 100644 index 0000000..7db8363 --- /dev/null +++ b/api/GetSavedInstanceChatLink.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string hyperlink +---Returns a hyperlink for a player's raid save +function GetSavedInstanceChatLink(index) end \ No newline at end of file diff --git a/api/GetSavedInstanceEncounterInfo.lua b/api/GetSavedInstanceEncounterInfo.lua new file mode 100644 index 0000000..ea53d3c --- /dev/null +++ b/api/GetSavedInstanceEncounterInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetSavedInstanceEncounterInfo() end \ No newline at end of file diff --git a/api/GetSavedInstanceInfo.lua b/api/GetSavedInstanceInfo.lua new file mode 100644 index 0000000..35f679c --- /dev/null +++ b/api/GetSavedInstanceInfo.lua @@ -0,0 +1,26 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string instanceName +---@return number instanceID +---@return number instanceReset +---@return 9 instanceDifficulty +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---@return 5 +---@return 6 +---@return 7 +---@return 8 +---@return 9 +---@return boolean locked +---@return boolean extended +---@return number instanceIDMostSig +---@return boolean isRaid +---@return number maxPlayers +---@return string difficultyName +---@return number maxBosses +---@return number defeatedBosses +---Returns information on a specific instance to which the player is saved +function GetSavedInstanceInfo(index) end \ No newline at end of file diff --git a/api/GetSavedWorldBossInfo.lua b/api/GetSavedWorldBossInfo.lua new file mode 100644 index 0000000..820d3d1 --- /dev/null +++ b/api/GetSavedWorldBossInfo.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string instanceName +---@return number worldBossID +---@return number instanceReset +---Returns information on a specific World Boss to which the player is saved. +function GetSavedWorldBossInfo(index) end \ No newline at end of file diff --git a/api/GetScenariosChoiceOrder.lua b/api/GetScenariosChoiceOrder.lua new file mode 100644 index 0000000..14b6b32 --- /dev/null +++ b/api/GetScenariosChoiceOrder.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetScenariosChoiceOrder() end \ No newline at end of file diff --git a/api/GetScreenHeight.lua b/api/GetScreenHeight.lua new file mode 100644 index 0000000..d22e2a9 --- /dev/null +++ b/api/GetScreenHeight.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number height +---Returns the height of the screen for UI layout purposes. Measurements for layout are affected by the UI Scale setting (i.e. the uiscale CVar) and may not match actual screen pixels. +function GetScreenHeight() end \ No newline at end of file diff --git a/api/GetScreenResolutions.lua b/api/GetScreenResolutions.lua new file mode 100644 index 0000000..2130dc6 --- /dev/null +++ b/api/GetScreenResolutions.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string ... +---Returns a list of available screen resolutions +function GetScreenResolutions() end \ No newline at end of file diff --git a/api/GetScreenWidth.lua b/api/GetScreenWidth.lua new file mode 100644 index 0000000..7306ca7 --- /dev/null +++ b/api/GetScreenWidth.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number screenWidth +---Returns the width of the screen for UI layout purposes. Measurements for layout are affected by the UI Scale setting (i.e. the uiscale CVar) and may not match actual screen pixels. +function GetScreenWidth() end \ No newline at end of file diff --git a/api/GetScriptCPUUsage.lua b/api/GetScriptCPUUsage.lua new file mode 100644 index 0000000..6069a76 --- /dev/null +++ b/api/GetScriptCPUUsage.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number usage +---Returns the total CPU time used by the scripting system. Only returns valid data if the scriptProfile CVar is set to 1; returns 0 otherwise. +function GetScriptCPUUsage() end \ No newline at end of file diff --git a/api/GetSelectedArtifactInfo.lua b/api/GetSelectedArtifactInfo.lua new file mode 100644 index 0000000..e66ac13 --- /dev/null +++ b/api/GetSelectedArtifactInfo.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string name +---@return string description +---@return number rarity +---@return string icon +---@return string spellDescription +---@return number numSockets +---@return string bgTexture +---Returns information about the currently selected artifact. Works even if the archeology panel is closed. Artifacts have specific information as well as information specific to the spell casted when creating the artifact. Common artifacts share the same description throughout the same race. +function GetSelectedArtifactInfo() end \ No newline at end of file diff --git a/api/GetSelectedAuctionItem.lua b/api/GetSelectedAuctionItem.lua new file mode 100644 index 0000000..575fa1b --- /dev/null +++ b/api/GetSelectedAuctionItem.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param list owner +---@param bidder +---@param list +---@param owner +---@return number index +---Returns the index of the currently selected item in an auction listing. Auction selection is used only for display and internal recordkeeping in the default UI; it has no direct effect on other Auction APIs. +function GetSelectedAuctionItem(list, bidder, list, owner) end \ No newline at end of file diff --git a/api/GetSelectedDisplayChannel.lua b/api/GetSelectedDisplayChannel.lua new file mode 100644 index 0000000..cdfa204 --- /dev/null +++ b/api/GetSelectedDisplayChannel.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number index +---Returns the selected channel in the channel list display +function GetSelectedDisplayChannel() end \ No newline at end of file diff --git a/api/GetSelectedFaction.lua b/api/GetSelectedFaction.lua new file mode 100644 index 0000000..2113264 --- /dev/null +++ b/api/GetSelectedFaction.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number index +---Returns which faction entry is selected in the reputation UI. Selection has no bearing on other faction-related APIs; this function merely facilitates behaviors of Blizzard's reputation UI. +function GetSelectedFaction() end \ No newline at end of file diff --git a/api/GetSelectedFriend.lua b/api/GetSelectedFriend.lua new file mode 100644 index 0000000..83a65ab --- /dev/null +++ b/api/GetSelectedFriend.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number index +---Returns the index of the selected character in the player's friends list. Selection in the Friends list is used only for display in the default UI and has no effect on other Friends list APIs. +function GetSelectedFriend() end \ No newline at end of file diff --git a/api/GetSelectedGlyphSpellIndex.lua b/api/GetSelectedGlyphSpellIndex.lua new file mode 100644 index 0000000..4f81082 --- /dev/null +++ b/api/GetSelectedGlyphSpellIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetSelectedGlyphSpellIndex() end \ No newline at end of file diff --git a/api/GetSelectedIgnore.lua b/api/GetSelectedIgnore.lua new file mode 100644 index 0000000..c0ca2e3 --- /dev/null +++ b/api/GetSelectedIgnore.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number index +---Returns the index of the selected character in the player's ignore list. Selection in the Ignore list is used only for display in the default UI and has no effect on other Ignore list APIs. +function GetSelectedIgnore() end \ No newline at end of file diff --git a/api/GetSelectedMute.lua b/api/GetSelectedMute.lua new file mode 100644 index 0000000..b991624 --- /dev/null +++ b/api/GetSelectedMute.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number selectedMute +---Returns the index of the selected entry in the Muted list. Mute list selection is only used for display purposes in the default UI and has no effect on other API functions. +function GetSelectedMute() end \ No newline at end of file diff --git a/api/GetSelectedStationeryTexture.lua b/api/GetSelectedStationeryTexture.lua new file mode 100644 index 0000000..d84879e --- /dev/null +++ b/api/GetSelectedStationeryTexture.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number index +---Returns the currently selected stationery type. Always returns 1; the stationery feature for sending mail is not implemented in the current version of World of Warcraft. +function GetSelectedStationeryTexture() end \ No newline at end of file diff --git a/api/GetSelectedWarGameType.lua b/api/GetSelectedWarGameType.lua new file mode 100644 index 0000000..e2adafb --- /dev/null +++ b/api/GetSelectedWarGameType.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetSelectedWarGameType() end \ No newline at end of file diff --git a/api/GetSendMailCOD.lua b/api/GetSendMailCOD.lua new file mode 100644 index 0000000..19525cc --- /dev/null +++ b/api/GetSendMailCOD.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number amount +---Returns the Cash-On-Delivery cost of the outgoing message. Returns the amount set via SetSendMailCOD(), which in the default UI is only called once its Send button has been clicked (immediately before sending the message). Thus, does not return the COD amount set in the default UI's Send Mail window. +function GetSendMailCOD() end \ No newline at end of file diff --git a/api/GetSendMailItem.lua b/api/GetSendMailItem.lua new file mode 100644 index 0000000..3d5318b --- /dev/null +++ b/api/GetSendMailItem.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return string itemName +---@return string itemTexture +---@return string stackCount +---@return number quality +---Returns information for an item attached to the outgoing message +function GetSendMailItem(slot) end \ No newline at end of file diff --git a/api/GetSendMailItemLink.lua b/api/GetSendMailItemLink.lua new file mode 100644 index 0000000..8760b77 --- /dev/null +++ b/api/GetSendMailItemLink.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return string itemlink +---Returns a hyperlink for an item attached to the outgoing message +function GetSendMailItemLink(slot) end \ No newline at end of file diff --git a/api/GetSendMailMoney.lua b/api/GetSendMailMoney.lua new file mode 100644 index 0000000..2a6e9a9 --- /dev/null +++ b/api/GetSendMailMoney.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number amount +---Returns the amount of money to be sent with the outgoing message. Returns the amount set via SetSendMailMoney(), which in the default UI is only called once its Send button has been clicked (immediately before sending the message). Thus, does not return the Send Money amount set in the default UI's Send Mail window. +function GetSendMailMoney() end \ No newline at end of file diff --git a/api/GetSendMailPrice.lua b/api/GetSendMailPrice.lua new file mode 100644 index 0000000..102c872 --- /dev/null +++ b/api/GetSendMailPrice.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number price +---Returns the cost to send the outgoing mail message. The cost of sending a message rises as more items are attached. +function GetSendMailPrice() end \ No newline at end of file diff --git a/api/GetSessionTime.lua b/api/GetSessionTime.lua new file mode 100644 index 0000000..d076e28 --- /dev/null +++ b/api/GetSessionTime.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetSessionTime() end \ No newline at end of file diff --git a/api/GetSetBonusesForSpecializationByItemID.lua b/api/GetSetBonusesForSpecializationByItemID.lua new file mode 100644 index 0000000..3e51179 --- /dev/null +++ b/api/GetSetBonusesForSpecializationByItemID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetSetBonusesForSpecializationByItemID() end \ No newline at end of file diff --git a/api/GetShapeshiftForm.lua b/api/GetShapeshiftForm.lua new file mode 100644 index 0000000..016853d --- /dev/null +++ b/api/GetShapeshiftForm.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number index +---Returns the index of the active ability on the stance/shapeshift bar +function GetShapeshiftForm() end \ No newline at end of file diff --git a/api/GetShapeshiftFormCooldown.lua b/api/GetShapeshiftFormCooldown.lua new file mode 100644 index 0000000..d0bb56f --- /dev/null +++ b/api/GetShapeshiftFormCooldown.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number start +---@return number duration +---@return number enable +---Returns cooldown information about an ability on the stance/shapeshift bar +function GetShapeshiftFormCooldown(index) end \ No newline at end of file diff --git a/api/GetShapeshiftFormID.lua b/api/GetShapeshiftFormID.lua new file mode 100644 index 0000000..c1b846d --- /dev/null +++ b/api/GetShapeshiftFormID.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number id +---Returns the ID of the active shapeshift form. Possible return values are: Druids: Bear Form - 5 (BEAR_FORM constant) Cat Form - 1 (CAT_FORM constant) Aquatic Form - 4 Travel Form - 3 Moonkin Form - 31 (MOONKIN_FORM constant) Tree of Life - 2 Flight Form - 27 Holy Priests: Chakra: Chastise - 1 Chakra: Sanctuary - 2 Chakra: Serenity - 3 Spirit of Redemption - 4 Warriors: Battle Stance - 17 Defensive Stance - 18 Berserker Stance - 19 Warlocks: Metamorphosis - 22 +function GetShapeshiftFormID() end \ No newline at end of file diff --git a/api/GetShapeshiftFormInfo.lua b/api/GetShapeshiftFormInfo.lua new file mode 100644 index 0000000..11f7238 --- /dev/null +++ b/api/GetShapeshiftFormInfo.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string texture +---@return string name +---@return 1nil isActive +---@return 1nil isCastable +---@return number spellID +---Returns information about an ability on the stance/shapeshift bar +function GetShapeshiftFormInfo(index) end \ No newline at end of file diff --git a/api/GetShieldBlock.lua b/api/GetShieldBlock.lua new file mode 100644 index 0000000..e1a229b --- /dev/null +++ b/api/GetShieldBlock.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number damage +---Returns the amount of damage prevented when the player blocks with a shield +function GetShieldBlock() end \ No newline at end of file diff --git a/api/GetSocketItemBoundTradeable.lua b/api/GetSocketItemBoundTradeable.lua new file mode 100644 index 0000000..2439d15 --- /dev/null +++ b/api/GetSocketItemBoundTradeable.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil tradeable +---Returns whether the item open for socketing is temporarily tradeable. A Bind on Pickup item looted by the player can be traded to other characters who were originally eligible to loot it, but only within a limited time after looting. This period can be ended prematurely if the player attempts certain actions (such as socketing gems into the item). +function GetSocketItemBoundTradeable() end \ No newline at end of file diff --git a/api/GetSocketItemInfo.lua b/api/GetSocketItemInfo.lua new file mode 100644 index 0000000..488b617 --- /dev/null +++ b/api/GetSocketItemInfo.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string name +---@return string icon +---@return number quality +---Returns information about the item currently being socketed. Only returns valid information when the Item Socketing UI is open (i.e. between the SOCKET_INFO_UPDATE and SOCKET_INFO_CLOSE events). +function GetSocketItemInfo() end \ No newline at end of file diff --git a/api/GetSocketItemRefundable.lua b/api/GetSocketItemRefundable.lua new file mode 100644 index 0000000..3191cd2 --- /dev/null +++ b/api/GetSocketItemRefundable.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil refundable +---Returns whether the item open for socketing is temporarily refundable. Items bought with alternate currency (honor points, arena points, or special items such as Emblems of Heroism and Dalaran Cooking Awards) can be returned to a vendor for a full refund, but only within a limited time after the original purchase. This period can be ended prematurely if the player attempts certain actions (such as socketing gems into the item). +function GetSocketItemRefundable() end \ No newline at end of file diff --git a/api/GetSocketTypes.lua b/api/GetSocketTypes.lua new file mode 100644 index 0000000..7800193 --- /dev/null +++ b/api/GetSocketTypes.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return Yellow gemColor +---@return Blue +---@return Meta +---@return Red +---@return Socket +---@return Yellow +---Returns information about the gem types usable in a socket. Only returns valid information when the Item Socketing UI is open (i.e. between the SOCKET_INFO_UPDATE and SOCKET_INFO_CLOSE events). +function GetSocketTypes(index) end \ No newline at end of file diff --git a/api/GetSortBagsRightToLeft.lua b/api/GetSortBagsRightToLeft.lua new file mode 100644 index 0000000..737e32b --- /dev/null +++ b/api/GetSortBagsRightToLeft.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetSortBagsRightToLeft() end \ No newline at end of file diff --git a/api/GetSpecialization.lua b/api/GetSpecialization.lua new file mode 100644 index 0000000..8cfdde7 --- /dev/null +++ b/api/GetSpecialization.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number specID +---Return non-global specialization ID of currently active specialization. +function GetSpecialization() end \ No newline at end of file diff --git a/api/GetSpecializationInfo.lua b/api/GetSpecializationInfo.lua new file mode 100644 index 0000000..d57f4b2 --- /dev/null +++ b/api/GetSpecializationInfo.lua @@ -0,0 +1,16 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param specID number +---@param isInspect boolean +---@param isPet boolean +---@param inspectTarget string +---@param gender number +---@return number id +---@return string name +---@return string description +---@return string icon +---@return string background +---@return string role +---@return number primaryStat +---Return additional data about player specializations. +function GetSpecializationInfo(specID, isInspect, isPet, inspectTarget, gender) end \ No newline at end of file diff --git a/api/GetSpecializationInfoByID.lua b/api/GetSpecializationInfoByID.lua new file mode 100644 index 0000000..1edc2e4 --- /dev/null +++ b/api/GetSpecializationInfoByID.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param specID number +---@return number id +---@return string name +---@return string description +---@return string icon +---@return string background +---@return string role +---@return string class +---Return additional data about specializations. +function GetSpecializationInfoByID(specID) end \ No newline at end of file diff --git a/api/GetSpecializationInfoForClassID.lua b/api/GetSpecializationInfoForClassID.lua new file mode 100644 index 0000000..d9b0c54 --- /dev/null +++ b/api/GetSpecializationInfoForClassID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetSpecializationInfoForClassID() end \ No newline at end of file diff --git a/api/GetSpecializationMasterySpells.lua b/api/GetSpecializationMasterySpells.lua new file mode 100644 index 0000000..e9d7a9a --- /dev/null +++ b/api/GetSpecializationMasterySpells.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param specIndex number +---@param isInspect boolean +---@param isPet boolean +---@return number spellID +---Returns spellID of the mastery spell for a given specialization index. +function GetSpecializationMasterySpells(specIndex, isInspect, isPet) end \ No newline at end of file diff --git a/api/GetSpecializationNameForSpecID.lua b/api/GetSpecializationNameForSpecID.lua new file mode 100644 index 0000000..afd6dda --- /dev/null +++ b/api/GetSpecializationNameForSpecID.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@return string name +---Return the Specialization name by global specialization ID. This function take in a global specialization ID to return the internationalized name of the specialization. +function GetSpecializationNameForSpecID(id) end \ No newline at end of file diff --git a/api/GetSpecializationReadinessSpell.lua b/api/GetSpecializationReadinessSpell.lua new file mode 100644 index 0000000..8ebeb8e --- /dev/null +++ b/api/GetSpecializationReadinessSpell.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetSpecializationReadinessSpell() end \ No newline at end of file diff --git a/api/GetSpecializationRole.lua b/api/GetSpecializationRole.lua new file mode 100644 index 0000000..91e6031 --- /dev/null +++ b/api/GetSpecializationRole.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetSpecializationRole() end \ No newline at end of file diff --git a/api/GetSpecializationRoleByID.lua b/api/GetSpecializationRoleByID.lua new file mode 100644 index 0000000..c507e93 --- /dev/null +++ b/api/GetSpecializationRoleByID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetSpecializationRoleByID() end \ No newline at end of file diff --git a/api/GetSpecializationSpells.lua b/api/GetSpecializationSpells.lua new file mode 100644 index 0000000..25f1138 --- /dev/null +++ b/api/GetSpecializationSpells.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param specIndex number +---@param isInspect boolean +---@param isPet boolean +---@return number spellID +---@return number levelLearned +---@return list ... +---Returns the spells associated with a specialization. +function GetSpecializationSpells(specIndex, isInspect, isPet) end \ No newline at end of file diff --git a/api/GetSpecsForSpell.lua b/api/GetSpecsForSpell.lua new file mode 100644 index 0000000..64c4e6c --- /dev/null +++ b/api/GetSpecsForSpell.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetSpecsForSpell() end \ No newline at end of file diff --git a/api/GetSpeed.lua b/api/GetSpeed.lua new file mode 100644 index 0000000..7002abc --- /dev/null +++ b/api/GetSpeed.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetSpeed() end \ No newline at end of file diff --git a/api/GetSpellAutocast.lua b/api/GetSpellAutocast.lua new file mode 100644 index 0000000..0fbc357 --- /dev/null +++ b/api/GetSpellAutocast.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@param bookType spell +---@param pet +---@param spell +---@return 1nil autocastAllowed +---@return 1nil autocastEnabled +---Returns information about automatic casting for a spell in the spellbook. Generally, only certain pet spells can be autocast. +function GetSpellAutocast(id, bookType, pet, spell) end \ No newline at end of file diff --git a/api/GetSpellAvailableLevel.lua b/api/GetSpellAvailableLevel.lua new file mode 100644 index 0000000..fbab915 --- /dev/null +++ b/api/GetSpellAvailableLevel.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetSpellAvailableLevel() end \ No newline at end of file diff --git a/api/GetSpellBaseCooldown.lua b/api/GetSpellBaseCooldown.lua new file mode 100644 index 0000000..176e9ce --- /dev/null +++ b/api/GetSpellBaseCooldown.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@return number cooldown +---Returns the base cooldown of a spell +function GetSpellBaseCooldown(id) end \ No newline at end of file diff --git a/api/GetSpellBonusDamage.lua b/api/GetSpellBonusDamage.lua new file mode 100644 index 0000000..52ff3e3 --- /dev/null +++ b/api/GetSpellBonusDamage.lua @@ -0,0 +1,13 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param school 7 +---@param 1 +---@param 2 +---@param 3 +---@param 4 +---@param 5 +---@param 6 +---@param 7 +---@return number minModifier +---Returns the player's spell damage bonus for a spell school +function GetSpellBonusDamage(school, 1, 2, 3, 4, 5, 6, 7) end \ No newline at end of file diff --git a/api/GetSpellBonusHealing.lua b/api/GetSpellBonusHealing.lua new file mode 100644 index 0000000..e329e78 --- /dev/null +++ b/api/GetSpellBonusHealing.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return integer bonusHealing +---Returns the player's amount of bonus healing +function GetSpellBonusHealing() end \ No newline at end of file diff --git a/api/GetSpellBookItemInfo.lua b/api/GetSpellBookItemInfo.lua new file mode 100644 index 0000000..80ec7dd --- /dev/null +++ b/api/GetSpellBookItemInfo.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param bookType spell +---@param pet +---@param spell +---@param spellName string +---@return string skillType +---@return number spellId +---Retrieves information about a specific SpellBook item +function GetSpellBookItemInfo(index, bookType, pet, spell, spellName) end \ No newline at end of file diff --git a/api/GetSpellBookItemName.lua b/api/GetSpellBookItemName.lua new file mode 100644 index 0000000..955eb1e --- /dev/null +++ b/api/GetSpellBookItemName.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param bookType spell +---@param pet +---@param spell +---@param spellName string +---@return string Name +---@return string Subtext +---Returns the name and sub-text of a spell in the spellbook +function GetSpellBookItemName(index, bookType, pet, spell, spellName) end \ No newline at end of file diff --git a/api/GetSpellBookItemTexture.lua b/api/GetSpellBookItemTexture.lua new file mode 100644 index 0000000..768b4d6 --- /dev/null +++ b/api/GetSpellBookItemTexture.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetSpellBookItemTexture() end \ No newline at end of file diff --git a/api/GetSpellCharges.lua b/api/GetSpellCharges.lua new file mode 100644 index 0000000..b7bc96f --- /dev/null +++ b/api/GetSpellCharges.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param id number +---@return number charges +---@return number maxCharges +---@return number start +---@return number duration +---Returns information on the number of charges on a spell in the spellbook +function GetSpellCharges(name, id) end \ No newline at end of file diff --git a/api/GetSpellConfirmationPromptsInfo.lua b/api/GetSpellConfirmationPromptsInfo.lua new file mode 100644 index 0000000..6c5b104 --- /dev/null +++ b/api/GetSpellConfirmationPromptsInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetSpellConfirmationPromptsInfo() end \ No newline at end of file diff --git a/api/GetSpellCooldown.lua b/api/GetSpellCooldown.lua new file mode 100644 index 0000000..9faab9e --- /dev/null +++ b/api/GetSpellCooldown.lua @@ -0,0 +1,13 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param bookType spell +---@param pet +---@param spell +---@param name string +---@param id number +---@return number start +---@return number duration +---@return number enable +---Returns cooldown information about a spell in the spellbook +function GetSpellCooldown(index, bookType, pet, spell, name, id) end \ No newline at end of file diff --git a/api/GetSpellCount.lua b/api/GetSpellCount.lua new file mode 100644 index 0000000..373cfec --- /dev/null +++ b/api/GetSpellCount.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param bookType spell +---@param pet +---@param spell +---@param name string +---@return number numCasts +---Returns the number of times a spell can be cast. Generally used for spells whose casting is limited by the number of item reagents in the player's possession. +function GetSpellCount(index, bookType, pet, spell, name) end \ No newline at end of file diff --git a/api/GetSpellCritChance.lua b/api/GetSpellCritChance.lua new file mode 100644 index 0000000..01a789b --- /dev/null +++ b/api/GetSpellCritChance.lua @@ -0,0 +1,13 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param school 7 +---@param 1 +---@param 2 +---@param 3 +---@param 4 +---@param 5 +---@param 6 +---@param 7 +---@return number minCrit +---Returns the player's spell critical strike chance for a spell school +function GetSpellCritChance(school, 1, 2, 3, 4, 5, 6, 7) end \ No newline at end of file diff --git a/api/GetSpellCritChanceFromIntellect.lua b/api/GetSpellCritChanceFromIntellect.lua new file mode 100644 index 0000000..1109111 --- /dev/null +++ b/api/GetSpellCritChanceFromIntellect.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return number critChance +---Returns additional spell critical strike chance provided by Intellect +function GetSpellCritChanceFromIntellect(unit) end \ No newline at end of file diff --git a/api/GetSpellDescription.lua b/api/GetSpellDescription.lua new file mode 100644 index 0000000..9e68965 --- /dev/null +++ b/api/GetSpellDescription.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param spellId number +---@return string desc +---Returns the description of a spell +function GetSpellDescription(spellId) end \ No newline at end of file diff --git a/api/GetSpellHitModifier.lua b/api/GetSpellHitModifier.lua new file mode 100644 index 0000000..9330b0a --- /dev/null +++ b/api/GetSpellHitModifier.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetSpellHitModifier() end \ No newline at end of file diff --git a/api/GetSpellInfo.lua b/api/GetSpellInfo.lua new file mode 100644 index 0000000..53db973 --- /dev/null +++ b/api/GetSpellInfo.lua @@ -0,0 +1,17 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param bookType spell +---@param pet +---@param spell +---@param name string +---@param id number +---@return string name +---@return string rank +---@return string icon +---@return number castingTime +---@return number minRange +---@return number maxRange +---@return number spellID +---Returns information about a spell. As of 4.1, this function should always return valid data for a spell if the spell is in the player's spellbook (by name or index) or if requested by spell id. When in doubt, if the player does not have the spell in their spellbook, use the numeric id to access its information. +function GetSpellInfo(index, bookType, pet, spell, name, id) end \ No newline at end of file diff --git a/api/GetSpellLevelLearned.lua b/api/GetSpellLevelLearned.lua new file mode 100644 index 0000000..3a8eedd --- /dev/null +++ b/api/GetSpellLevelLearned.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetSpellLevelLearned() end \ No newline at end of file diff --git a/api/GetSpellLink.lua b/api/GetSpellLink.lua new file mode 100644 index 0000000..708c60b --- /dev/null +++ b/api/GetSpellLink.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param bookType spell +---@param pet +---@param spell +---@param name string +---@param id number +---@return string link +---@return string tradeLink +---Returns a hyperlink for a spell +function GetSpellLink(index, bookType, pet, spell, name, id) end \ No newline at end of file diff --git a/api/GetSpellLossOfControlCooldown.lua b/api/GetSpellLossOfControlCooldown.lua new file mode 100644 index 0000000..9bc9add --- /dev/null +++ b/api/GetSpellLossOfControlCooldown.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetSpellLossOfControlCooldown() end \ No newline at end of file diff --git a/api/GetSpellPenetration.lua b/api/GetSpellPenetration.lua new file mode 100644 index 0000000..0602f04 --- /dev/null +++ b/api/GetSpellPenetration.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number penetration +---Returns the amount of enemy magic resistance ignored due to the player's Spell Penetration Rating +function GetSpellPenetration() end \ No newline at end of file diff --git a/api/GetSpellTabInfo.lua b/api/GetSpellTabInfo.lua new file mode 100644 index 0000000..64c0982 --- /dev/null +++ b/api/GetSpellTabInfo.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---@return string texture +---@return number offset +---@return number numSpells +---Returns information about a tab in the spellbook +function GetSpellTabInfo(index) end \ No newline at end of file diff --git a/api/GetSpellTexture.lua b/api/GetSpellTexture.lua new file mode 100644 index 0000000..04c7e0d --- /dev/null +++ b/api/GetSpellTexture.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param bookType spell +---@param pet +---@param spell +---@param name string +---@return string texture +---Returns the icon texture path for a spell +function GetSpellTexture(index, bookType, pet, spell, name) end \ No newline at end of file diff --git a/api/GetSpellsForCharacterUpgradeTier.lua b/api/GetSpellsForCharacterUpgradeTier.lua new file mode 100644 index 0000000..a1d739e --- /dev/null +++ b/api/GetSpellsForCharacterUpgradeTier.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetSpellsForCharacterUpgradeTier() end \ No newline at end of file diff --git a/api/GetStablePetFoodTypes.lua b/api/GetStablePetFoodTypes.lua new file mode 100644 index 0000000..f02d918 --- /dev/null +++ b/api/GetStablePetFoodTypes.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index 1 to NUM_PET_STABLE_SLOTS +---@param 0 +---@param 1 to NUM_PET_STABLE_SLOTS +---@return list ... +---Returns the types of food that a stabled pet will eat +function GetStablePetFoodTypes(index, 0, 1 to NUM_PET_STABLE_SLOTS) end \ No newline at end of file diff --git a/api/GetStablePetInfo.lua b/api/GetStablePetInfo.lua new file mode 100644 index 0000000..9eb6174 --- /dev/null +++ b/api/GetStablePetInfo.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index 1 to NUM_PET_STABLE_SLOTS +---@param 0 +---@param 1 to NUM_PET_STABLE_SLOTS +---@return string icon +---@return string name +---@return number level +---@return string family +---@return string talent +---Returns information about a stabled pet +function GetStablePetInfo(index, 0, 1 to NUM_PET_STABLE_SLOTS) end \ No newline at end of file diff --git a/api/GetStationeryInfo.lua b/api/GetStationeryInfo.lua new file mode 100644 index 0000000..a41b0ca --- /dev/null +++ b/api/GetStationeryInfo.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---@return string texture +---@return number cost +---Returns information about a stationery type. Only returns information for the default stationery type; the stationery feature for sending mail is not implemented in the current version of World of Warcraft. +function GetStationeryInfo(index) end \ No newline at end of file diff --git a/api/GetStatistic.lua b/api/GetStatistic.lua new file mode 100644 index 0000000..6b293ec --- /dev/null +++ b/api/GetStatistic.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@return string info +---Returns data for a statistic that can be shown on the statistics tab of the achievements window +function GetStatistic(id) end \ No newline at end of file diff --git a/api/GetStatisticsCategoryList.lua b/api/GetStatisticsCategoryList.lua new file mode 100644 index 0000000..621a74a --- /dev/null +++ b/api/GetStatisticsCategoryList.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return table categories +---Returns a list of all statistic categories +function GetStatisticsCategoryList() end \ No newline at end of file diff --git a/api/GetSubZoneText.lua b/api/GetSubZoneText.lua new file mode 100644 index 0000000..65f0731 --- /dev/null +++ b/api/GetSubZoneText.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string subzoneText +---Returns the name of the minor area in which the player is located. Subzones are named regions within a larger zone or instance: e.g. the Valley of Trials in Durotar, the Terrace of Light in Shattrath City, or the Njorn Stair in Utgarde Keep. +function GetSubZoneText() end \ No newline at end of file diff --git a/api/GetSuggestedGroupNum.lua b/api/GetSuggestedGroupNum.lua new file mode 100644 index 0000000..387fdc6 --- /dev/null +++ b/api/GetSuggestedGroupNum.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number suggestedGroup +---Returns the suggested group size for attempting the quest currently offered by a questgiver. Usable following the QUEST_DETAIL event in which the questgiver presents the player with the details of a quest and the option to accept or decline. +function GetSuggestedGroupNum() end \ No newline at end of file diff --git a/api/GetSummonConfirmAreaName.lua b/api/GetSummonConfirmAreaName.lua new file mode 100644 index 0000000..eda5f33 --- /dev/null +++ b/api/GetSummonConfirmAreaName.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string area +---Returns the destination area of an offered summons. The name returned is generally that of the subzone in which the summoner performed the spell. Usable between when the CONFIRM_SUMMON event fires (due to a summoning spell cast by another player) and when the value returned by GetSummonConfirmTimeLeft() reaches zero. +function GetSummonConfirmAreaName() end \ No newline at end of file diff --git a/api/GetSummonConfirmSummoner.lua b/api/GetSummonConfirmSummoner.lua new file mode 100644 index 0000000..67fdae5 --- /dev/null +++ b/api/GetSummonConfirmSummoner.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string text +---Returns the name of the unit offering a summons to the player. Usable between when the CONFIRM_SUMMON event fires (due to a summoning spell cast by another player) and when the value returned by GetSummonConfirmTimeLeft() reaches zero. +function GetSummonConfirmSummoner() end \ No newline at end of file diff --git a/api/GetSummonConfirmTimeLeft.lua b/api/GetSummonConfirmTimeLeft.lua new file mode 100644 index 0000000..9bf8def --- /dev/null +++ b/api/GetSummonConfirmTimeLeft.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number timeleft +---Returns the amount of time remaining before an offered summons expires. Returns 0 if no summons is currently available. +function GetSummonConfirmTimeLeft() end \ No newline at end of file diff --git a/api/GetSummonFriendCooldown.lua b/api/GetSummonFriendCooldown.lua new file mode 100644 index 0000000..3552fca --- /dev/null +++ b/api/GetSummonFriendCooldown.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number start +---@return number duration +---Returns cooldown information about the player's Summon Friend ability +function GetSummonFriendCooldown() end \ No newline at end of file diff --git a/api/GetSuperTrackedQuestID.lua b/api/GetSuperTrackedQuestID.lua new file mode 100644 index 0000000..42db403 --- /dev/null +++ b/api/GetSuperTrackedQuestID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetSuperTrackedQuestID() end \ No newline at end of file diff --git a/api/GetTabardCreationCost.lua b/api/GetTabardCreationCost.lua new file mode 100644 index 0000000..b573684 --- /dev/null +++ b/api/GetTabardCreationCost.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number cost +---Returns the cost to create a guild tabard. Only returns valid data if the player is interacting with a tabard designer (i.e. between the OPEN_TABARD_FRAME and CLOSE_TABARD_FRAME events). +function GetTabardCreationCost() end \ No newline at end of file diff --git a/api/GetTabardInfo.lua b/api/GetTabardInfo.lua new file mode 100644 index 0000000..d33bfa9 --- /dev/null +++ b/api/GetTabardInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetTabardInfo() end \ No newline at end of file diff --git a/api/GetTalentClearInfo.lua b/api/GetTalentClearInfo.lua new file mode 100644 index 0000000..633e8c0 --- /dev/null +++ b/api/GetTalentClearInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetTalentClearInfo() end \ No newline at end of file diff --git a/api/GetTalentInfo.lua b/api/GetTalentInfo.lua new file mode 100644 index 0000000..aa6ed38 --- /dev/null +++ b/api/GetTalentInfo.lua @@ -0,0 +1,18 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param tier number +---@param column number +---@param talentGroup number +---@param isInspect boolean +---@param inspectedUnit string +---@return string talentID +---@return string name +---@return string texture +---@return boolean selected +---@return boolean available +---@return number spellid +---@return number tier +---@return number column +---@return boolean selected +---Returns information about a talent option +function GetTalentInfo(tier, column, talentGroup, isInspect, inspectedUnit) end \ No newline at end of file diff --git a/api/GetTalentInfoByID.lua b/api/GetTalentInfoByID.lua new file mode 100644 index 0000000..9cc765c --- /dev/null +++ b/api/GetTalentInfoByID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetTalentInfoByID() end \ No newline at end of file diff --git a/api/GetTalentInfoBySpecialization.lua b/api/GetTalentInfoBySpecialization.lua new file mode 100644 index 0000000..5f071b5 --- /dev/null +++ b/api/GetTalentInfoBySpecialization.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetTalentInfoBySpecialization() end \ No newline at end of file diff --git a/api/GetTalentLink.lua b/api/GetTalentLink.lua new file mode 100644 index 0000000..cd9e090 --- /dev/null +++ b/api/GetTalentLink.lua @@ -0,0 +1,13 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param tabIndex number +---@param talentIndex number +---@param inspect boolean +---@param pet boolean +---@param talentGroup nil +---@param 1 +---@param 2 +---@param nil +---@return string link +---Returns a hyperlink for a talent +function GetTalentLink(tabIndex, talentIndex, inspect, pet, talentGroup, 1, 2, nil) end \ No newline at end of file diff --git a/api/GetTalentRowSelectionInfo.lua b/api/GetTalentRowSelectionInfo.lua new file mode 100644 index 0000000..5ac0d1e --- /dev/null +++ b/api/GetTalentRowSelectionInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetTalentRowSelectionInfo() end \ No newline at end of file diff --git a/api/GetTargetTradeCurrency.lua b/api/GetTargetTradeCurrency.lua new file mode 100644 index 0000000..bbd31b1 --- /dev/null +++ b/api/GetTargetTradeCurrency.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetTargetTradeCurrency() end \ No newline at end of file diff --git a/api/GetTargetTradeMoney.lua b/api/GetTargetTradeMoney.lua new file mode 100644 index 0000000..e8571af --- /dev/null +++ b/api/GetTargetTradeMoney.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number amount +---Returns the amount of money offered for trade by the target +function GetTargetTradeMoney() end \ No newline at end of file diff --git a/api/GetTaxiBenchmarkMode.lua b/api/GetTaxiBenchmarkMode.lua new file mode 100644 index 0000000..683ee3e --- /dev/null +++ b/api/GetTaxiBenchmarkMode.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isBenchmark +---Returns whether flight path benchmark mode is enabled +function GetTaxiBenchmarkMode() end \ No newline at end of file diff --git a/api/GetTempShapeshiftBarIndex.lua b/api/GetTempShapeshiftBarIndex.lua new file mode 100644 index 0000000..e6fc052 --- /dev/null +++ b/api/GetTempShapeshiftBarIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetTempShapeshiftBarIndex() end \ No newline at end of file diff --git a/api/GetText.lua b/api/GetText.lua new file mode 100644 index 0000000..ab97e0d --- /dev/null +++ b/api/GetText.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param token string +---@param gender number +---@param ordinal number +---@return string text +---Returns a localized string according to given parameters. Applies to any global variable whose name fits a standard format: for example, GetText("foo") returns the value of the global variable foo (if it exists), and GetText("foo", 3) returns the value of foo_FEMALE (or if it does not exist, the value of foo). Causes a Lua error if the given variable does not exists (or is nil). +function GetText(token, gender, ordinal) end \ No newline at end of file diff --git a/api/GetThreatStatusColor.lua b/api/GetThreatStatusColor.lua new file mode 100644 index 0000000..b9cb077 --- /dev/null +++ b/api/GetThreatStatusColor.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param status number +---@return number red +---@return number green +---@return number blue +---Returns color values for a given threat status. Color component values are floating point numbers between 0 and 1, with 1 representing full intensity. +function GetThreatStatusColor(status) end \ No newline at end of file diff --git a/api/GetTime.lua b/api/GetTime.lua new file mode 100644 index 0000000..13084f0 --- /dev/null +++ b/api/GetTime.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number time +---Returns a number representing the current time (with millisecond precision). Unlike with time(), the number returned by this function has no meaning of its own and may not be comparable across clients; however, since it also provides higher resolution it can be compared against itself for high-precision time measurements. As of patch 4.3 this function's value is cached and will not change until the next OnUpdate fires. See debugprofilestop() for an alternative. +function GetTime() end \ No newline at end of file diff --git a/api/GetTimeToWellRested.lua b/api/GetTimeToWellRested.lua new file mode 100644 index 0000000..8d22f6f --- /dev/null +++ b/api/GetTimeToWellRested.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetTimeToWellRested() end \ No newline at end of file diff --git a/api/GetTitleName.lua b/api/GetTitleName.lua new file mode 100644 index 0000000..5ab0161 --- /dev/null +++ b/api/GetTitleName.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param titleIndex integer +---@return string titleName +---Returns the text of an available player title +function GetTitleName(titleIndex) end \ No newline at end of file diff --git a/api/GetTitleText.lua b/api/GetTitleText.lua new file mode 100644 index 0000000..1e52915 --- /dev/null +++ b/api/GetTitleText.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string text +---Returns the title text for the quest presented by a questgiver. Only valid following the QUEST_DETAIL, QUEST_PROGRESS, or QUEST_COMPLETE events; otherwise may return nil or a value from the most recently displayed quest. +function GetTitleText() end \ No newline at end of file diff --git a/api/GetTotalAchievementPoints.lua b/api/GetTotalAchievementPoints.lua new file mode 100644 index 0000000..82414e5 --- /dev/null +++ b/api/GetTotalAchievementPoints.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param guild bool +---@return number points +---Returns the player's total achievement points earned +function GetTotalAchievementPoints(guild) end \ No newline at end of file diff --git a/api/GetTotemInfo.lua b/api/GetTotemInfo.lua new file mode 100644 index 0000000..a62542c --- /dev/null +++ b/api/GetTotemInfo.lua @@ -0,0 +1,14 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot 4 +---@param 1 +---@param 2 +---@param 3 +---@param 4 +---@return boolean haveTotem +---@return string name +---@return number startTime +---@return number duration +---@return string icon +---Returns information on a currently active totem (or ghoul). Totem functions are also used for ghouls summoned by a Death Knight's Raise Dead ability (if the ghoul is not made a controllable pet by the Master of Ghouls talent), for druids' wild mushrooms, and Affliction Warlock's Soul Effigy. +function GetTotemInfo(slot, 1, 2, 3, 4) end \ No newline at end of file diff --git a/api/GetTotemTimeLeft.lua b/api/GetTotemTimeLeft.lua new file mode 100644 index 0000000..0d466d3 --- /dev/null +++ b/api/GetTotemTimeLeft.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot 4 +---@param 1 +---@param 2 +---@param 3 +---@param 4 +---@return number seconds +---Returns the time remaining before a totem (or ghoul) automatically disappears. Using GetTime() and the third and fourth returns (startTime and duration) of GetTotemInfo() instead of this function is recommended if frequent updates are needed. Totem functions are also used for ghouls summoned by a Death Knight's Raise Dead ability (if the ghoul is not made a controllable pet by the Master of Ghouls talent). +function GetTotemTimeLeft(slot, 1, 2, 3, 4) end \ No newline at end of file diff --git a/api/GetTrackedAchievements.lua b/api/GetTrackedAchievements.lua new file mode 100644 index 0000000..c71b900 --- /dev/null +++ b/api/GetTrackedAchievements.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return list ... +---Returns numeric IDs of the achievements flagged for display in the objectives tracker UI +function GetTrackedAchievements() end \ No newline at end of file diff --git a/api/GetTrackingInfo.lua b/api/GetTrackingInfo.lua new file mode 100644 index 0000000..60453be --- /dev/null +++ b/api/GetTrackingInfo.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---@return string texture +---@return 1nil active +---@return spell category +---@return other +---@return spell +---Returns information about a given tracking option +function GetTrackingInfo(index) end \ No newline at end of file diff --git a/api/GetTradePlayerItemInfo.lua b/api/GetTradePlayerItemInfo.lua new file mode 100644 index 0000000..32043a0 --- /dev/null +++ b/api/GetTradePlayerItemInfo.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---@return string texture +---@return number numItems +---@return number quality +---@return 1nil isUsable +---@return string enchantment +---Returns information about an item offered for trade by the player +function GetTradePlayerItemInfo(index) end \ No newline at end of file diff --git a/api/GetTradePlayerItemLink.lua b/api/GetTradePlayerItemLink.lua new file mode 100644 index 0000000..f9b9091 --- /dev/null +++ b/api/GetTradePlayerItemLink.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string link +---Returns a hyperlink for an item offered for trade by the player +function GetTradePlayerItemLink(index) end \ No newline at end of file diff --git a/api/GetTradeSkillCategoryFilter.lua b/api/GetTradeSkillCategoryFilter.lua new file mode 100644 index 0000000..c8160e4 --- /dev/null +++ b/api/GetTradeSkillCategoryFilter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetTradeSkillCategoryFilter() end \ No newline at end of file diff --git a/api/GetTradeSkillCooldown.lua b/api/GetTradeSkillCooldown.lua new file mode 100644 index 0000000..4424454 --- /dev/null +++ b/api/GetTradeSkillCooldown.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number cooldown +---Returns the time remaining on a trade skill recipe's cooldown +function GetTradeSkillCooldown(index) end \ No newline at end of file diff --git a/api/GetTradeSkillDescription.lua b/api/GetTradeSkillDescription.lua new file mode 100644 index 0000000..b732bc6 --- /dev/null +++ b/api/GetTradeSkillDescription.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string description +---Returns descriptive text for a tradeskill recipe. Most recipes that create items don't provide descriptive text; it's more often used for enchants and special recipes such as inscription or alchemy research. +function GetTradeSkillDescription(index) end \ No newline at end of file diff --git a/api/GetTradeSkillIcon.lua b/api/GetTradeSkillIcon.lua new file mode 100644 index 0000000..65b3314 --- /dev/null +++ b/api/GetTradeSkillIcon.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string texturePath +---Returns the icon for a trade skill recipe. For recipes which create an item, this is generally the icon of the item created; for other recipes (such as enchants and alchemy/inscription research) a generic icon is used. +function GetTradeSkillIcon(index) end \ No newline at end of file diff --git a/api/GetTradeSkillInfo.lua b/api/GetTradeSkillInfo.lua new file mode 100644 index 0000000..d2225c7 --- /dev/null +++ b/api/GetTradeSkillInfo.lua @@ -0,0 +1,29 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string skillName +---@return trivial skillType +---@return easy +---@return header +---@return medium +---@return optimal +---@return trivial +---@return number numAvailable +---@return 1nil isExpanded +---@return nil serviceType +---@return Emboss +---@return Embrodier +---@return Enchant +---@return Engrave +---@return Inscribe +---@return Modify +---@return Tinker +---@return nil +---@return number numSkillUps +---@return number indentLevel +---@return 1nil showProgressBar +---@return number currentRank +---@return number maxRank +---@return number startingRank +---Returns information about a trade skill header or recipe +function GetTradeSkillInfo(index) end \ No newline at end of file diff --git a/api/GetTradeSkillInvSlotFilter.lua b/api/GetTradeSkillInvSlotFilter.lua new file mode 100644 index 0000000..0ee31e1 --- /dev/null +++ b/api/GetTradeSkillInvSlotFilter.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return 1nil enabled +---Returns whether the trade skill listing is filtered by a given item equipment slot +function GetTradeSkillInvSlotFilter(index) end \ No newline at end of file diff --git a/api/GetTradeSkillInvSlots.lua b/api/GetTradeSkillInvSlots.lua new file mode 100644 index 0000000..1dac60c --- /dev/null +++ b/api/GetTradeSkillInvSlots.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return list ... +---Returns a list of recipe equipment slots for the current trade skill. These inventory types correspond to those of the items produced (see GetItemInfo() and GetAuctionItemInvTypes()) and can be used to filter the recipe list. +function GetTradeSkillInvSlots() end \ No newline at end of file diff --git a/api/GetTradeSkillItemLevelFilter.lua b/api/GetTradeSkillItemLevelFilter.lua new file mode 100644 index 0000000..bf24a47 --- /dev/null +++ b/api/GetTradeSkillItemLevelFilter.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number minLevel +---@return number maxLevel +---Returns the current settings for filtering the trade skill listing by required level of items produced +function GetTradeSkillItemLevelFilter() end \ No newline at end of file diff --git a/api/GetTradeSkillItemLink.lua b/api/GetTradeSkillItemLink.lua new file mode 100644 index 0000000..61faaad --- /dev/null +++ b/api/GetTradeSkillItemLink.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string link +---Returns a hyperlink for the item created by a tradeskill recipe. The tooltip produced when resolving the link describes only the item created by the recipe. For a link which describes the recipe itself (its reagents and description), see GetTradeSkillRecipeLink(). If the recipe does not create an item, this function returns the same hyperlink as does GetTradeSkillRecipeLink() (though the text of the link may differ). +function GetTradeSkillItemLink(index) end \ No newline at end of file diff --git a/api/GetTradeSkillItemNameFilter.lua b/api/GetTradeSkillItemNameFilter.lua new file mode 100644 index 0000000..ec8adef --- /dev/null +++ b/api/GetTradeSkillItemNameFilter.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string text +---Returns the current search text for filtering the trade skill listing by name +function GetTradeSkillItemNameFilter() end \ No newline at end of file diff --git a/api/GetTradeSkillLine.lua b/api/GetTradeSkillLine.lua new file mode 100644 index 0000000..2dbabc5 --- /dev/null +++ b/api/GetTradeSkillLine.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string tradeskillName +---@return number rank +---@return number maxLevel +---Returns information about the current trade skill +function GetTradeSkillLine() end \ No newline at end of file diff --git a/api/GetTradeSkillListLink.lua b/api/GetTradeSkillListLink.lua new file mode 100644 index 0000000..63a9602 --- /dev/null +++ b/api/GetTradeSkillListLink.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string link +---Returns a hyperlink to the player's list of recipes for the current trade skill +function GetTradeSkillListLink() end \ No newline at end of file diff --git a/api/GetTradeSkillNumMade.lua b/api/GetTradeSkillNumMade.lua new file mode 100644 index 0000000..e457e0e --- /dev/null +++ b/api/GetTradeSkillNumMade.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number minMade +---@return number maxMade +---Returns the number of items created when performing a tradeskill recipe +function GetTradeSkillNumMade(index) end \ No newline at end of file diff --git a/api/GetTradeSkillNumReagents.lua b/api/GetTradeSkillNumReagents.lua new file mode 100644 index 0000000..d43092d --- /dev/null +++ b/api/GetTradeSkillNumReagents.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number numReagents +---Returns the number of different reagents required for a trade skill recipe +function GetTradeSkillNumReagents(index) end \ No newline at end of file diff --git a/api/GetTradeSkillReagentInfo.lua b/api/GetTradeSkillReagentInfo.lua new file mode 100644 index 0000000..f9defd2 --- /dev/null +++ b/api/GetTradeSkillReagentInfo.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param skillIndex number +---@param reagentIndex number +---@return string reagentName +---@return string reagentTexture +---@return number reagentCount +---@return number playerReagentCount +---Returns information about a reagent in a trade skill recipe +function GetTradeSkillReagentInfo(skillIndex, reagentIndex) end \ No newline at end of file diff --git a/api/GetTradeSkillReagentItemLink.lua b/api/GetTradeSkillReagentItemLink.lua new file mode 100644 index 0000000..37425bc --- /dev/null +++ b/api/GetTradeSkillReagentItemLink.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param skillIndex number +---@param reagentIndex number +---@return string link +---Returns a hyperlink for a reagent in a tradeskill recipe +function GetTradeSkillReagentItemLink(skillIndex, reagentIndex) end \ No newline at end of file diff --git a/api/GetTradeSkillRecipeLink.lua b/api/GetTradeSkillRecipeLink.lua new file mode 100644 index 0000000..119e78e --- /dev/null +++ b/api/GetTradeSkillRecipeLink.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string link +---Returns hyperlink for a tradeskill recipe. The tooltip produced when resolving the link describes the recipe itself -- its reagents and (if present) description -- in addition to (if applicable) the item created. For a link which only describes the created item, see GetTradeSkillItemLink(). +function GetTradeSkillRecipeLink(index) end \ No newline at end of file diff --git a/api/GetTradeSkillSelectionIndex.lua b/api/GetTradeSkillSelectionIndex.lua new file mode 100644 index 0000000..5ffec4b --- /dev/null +++ b/api/GetTradeSkillSelectionIndex.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number index +---Returns the index of the currently selected trade skill recipe. Selection in the recipe list is used only for display in the default UI and has no effect on other Trade Skill APIs. +function GetTradeSkillSelectionIndex() end \ No newline at end of file diff --git a/api/GetTradeSkillSubCategories.lua b/api/GetTradeSkillSubCategories.lua new file mode 100644 index 0000000..2956320 --- /dev/null +++ b/api/GetTradeSkillSubCategories.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetTradeSkillSubCategories() end \ No newline at end of file diff --git a/api/GetTradeSkillSubClassFilteredSlots.lua b/api/GetTradeSkillSubClassFilteredSlots.lua new file mode 100644 index 0000000..bc80191 --- /dev/null +++ b/api/GetTradeSkillSubClassFilteredSlots.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetTradeSkillSubClassFilteredSlots() end \ No newline at end of file diff --git a/api/GetTradeSkillSubClasses.lua b/api/GetTradeSkillSubClasses.lua new file mode 100644 index 0000000..bfa3f47 --- /dev/null +++ b/api/GetTradeSkillSubClasses.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return list ... +---Returns a list of recipe subclasses for the current trade skill. These subclasses correspond to those of the items produced (see GetItemInfo() and GetAuctionItemSubClasses()) and can be used to filter the recipe list. +function GetTradeSkillSubClasses() end \ No newline at end of file diff --git a/api/GetTradeSkillTexture.lua b/api/GetTradeSkillTexture.lua new file mode 100644 index 0000000..a397967 --- /dev/null +++ b/api/GetTradeSkillTexture.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetTradeSkillTexture() end \ No newline at end of file diff --git a/api/GetTradeSkillTools.lua b/api/GetTradeSkillTools.lua new file mode 100644 index 0000000..87761af --- /dev/null +++ b/api/GetTradeSkillTools.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string toolName +---@return 1nil hasTool +---@return list ... +---Returns a list of required tools for a trade skill recipe. A tool may be an item (e.g. Blacksmith Hammer, Virtuoso Inking Set) the player must possess, or a description of a generic (e.g. near an Anvil, in a Moonwell) or specific (e.g. Netherstorm, Emerald Dragonshrine) location to which the player must travel in order to perform the recipe. The hasTool return is only valid for the former. +function GetTradeSkillTools(index) end \ No newline at end of file diff --git a/api/GetTradeTargetItemInfo.lua b/api/GetTradeTargetItemInfo.lua new file mode 100644 index 0000000..78dbbf0 --- /dev/null +++ b/api/GetTradeTargetItemInfo.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---@return string texture +---@return number numItems +---@return number quality +---@return 1nil isUsable +---@return string enchantment +---Returns information about an item offered for trade by the target +function GetTradeTargetItemInfo(index) end \ No newline at end of file diff --git a/api/GetTradeTargetItemLink.lua b/api/GetTradeTargetItemLink.lua new file mode 100644 index 0000000..ea023cb --- /dev/null +++ b/api/GetTradeTargetItemLink.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string link +---Returns a hyperlink for an item offered for trade by the target +function GetTradeTargetItemLink(index) end \ No newline at end of file diff --git a/api/GetTradeskillRepeatCount.lua b/api/GetTradeskillRepeatCount.lua new file mode 100644 index 0000000..404c514 --- /dev/null +++ b/api/GetTradeskillRepeatCount.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number repeatCount +---Returns the number of times the trade skill recipe currently being performed will repeat. Returns 1 if a recipe is not being performed; after DoTradeSkill() is called, returns the number of repetitions queued (which decrements as each repetition is finished). +function GetTradeskillRepeatCount() end \ No newline at end of file diff --git a/api/GetTrainerGreetingText.lua b/api/GetTrainerGreetingText.lua new file mode 100644 index 0000000..6a106b2 --- /dev/null +++ b/api/GetTrainerGreetingText.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string text +---Returns the current trainer's greeting text. In the default UI, this text is displayed at the top of the trainer window. May return the empty string or the last used trainer's greeting text if called while not interacting with a trainer. +function GetTrainerGreetingText() end \ No newline at end of file diff --git a/api/GetTrainerSelectionIndex.lua b/api/GetTrainerSelectionIndex.lua new file mode 100644 index 0000000..2260a20 --- /dev/null +++ b/api/GetTrainerSelectionIndex.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number selectionIndex +---Returns the index of the currently selected trainer service. Selection in the recipe list is used only for display in the default UI and has no effect on other Trade Skill APIs. +function GetTrainerSelectionIndex() end \ No newline at end of file diff --git a/api/GetTrainerServiceAbilityReq.lua b/api/GetTrainerServiceAbilityReq.lua new file mode 100644 index 0000000..3d20a4c --- /dev/null +++ b/api/GetTrainerServiceAbilityReq.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param abilityIndex number +---@return string ability +---@return 1nil hasReq +---Returns information about an ability required for purchasing a trainer service +function GetTrainerServiceAbilityReq(index, abilityIndex) end \ No newline at end of file diff --git a/api/GetTrainerServiceCost.lua b/api/GetTrainerServiceCost.lua new file mode 100644 index 0000000..921351f --- /dev/null +++ b/api/GetTrainerServiceCost.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number moneyCost +---@return number talentCost +---@return number skillCost +---Returns the cost to purchase a trainer service +function GetTrainerServiceCost(index) end \ No newline at end of file diff --git a/api/GetTrainerServiceDescription.lua b/api/GetTrainerServiceDescription.lua new file mode 100644 index 0000000..755ee84 --- /dev/null +++ b/api/GetTrainerServiceDescription.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string text +---Returns the description of a trainer service. Generally returns the same description found in the spell's tooltip for spells purchased from a class trainer; returns nil for trade skills and recipes. +function GetTrainerServiceDescription(index) end \ No newline at end of file diff --git a/api/GetTrainerServiceIcon.lua b/api/GetTrainerServiceIcon.lua new file mode 100644 index 0000000..d0ae360 --- /dev/null +++ b/api/GetTrainerServiceIcon.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string icon +---Returns the icon for a trainer service +function GetTrainerServiceIcon(index) end \ No newline at end of file diff --git a/api/GetTrainerServiceInfo.lua b/api/GetTrainerServiceInfo.lua new file mode 100644 index 0000000..17474b5 --- /dev/null +++ b/api/GetTrainerServiceInfo.lua @@ -0,0 +1,15 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string serviceName +---@return string serviceSubText +---@return used serviceType +---@return available +---@return header +---@return unavailable +---@return used +---@return string iconTexture +---@return number reqLevel +---@return 1nil isExpanded +---Returns information about an entry in the trainer service listing +function GetTrainerServiceInfo(index) end \ No newline at end of file diff --git a/api/GetTrainerServiceItemLink.lua b/api/GetTrainerServiceItemLink.lua new file mode 100644 index 0000000..df467af --- /dev/null +++ b/api/GetTrainerServiceItemLink.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string link +---Returns a hyperlink for the item associated with a trainer service. Currently only returns item links for trainer services which teach trade skill recipes which produce items; does not return spell or recipe links. +function GetTrainerServiceItemLink(index) end \ No newline at end of file diff --git a/api/GetTrainerServiceLevelReq.lua b/api/GetTrainerServiceLevelReq.lua new file mode 100644 index 0000000..37a6816 --- /dev/null +++ b/api/GetTrainerServiceLevelReq.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number reqLevel +---Returns the character level required to purchase a trainer service +function GetTrainerServiceLevelReq(index) end \ No newline at end of file diff --git a/api/GetTrainerServiceNumAbilityReq.lua b/api/GetTrainerServiceNumAbilityReq.lua new file mode 100644 index 0000000..756b804 --- /dev/null +++ b/api/GetTrainerServiceNumAbilityReq.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number numRequirements +---Returns the number of ability requirements for purchasing a trainer service. Ability requirements are often used for ranked class spells purchased from the trainer: e.g. learning Blood Strike (Rank 3) requires having learned Blood Strike (Rank 2). See GetTrainerServiceAbilityReq() for information about specific ability requirements. +function GetTrainerServiceNumAbilityReq(index) end \ No newline at end of file diff --git a/api/GetTrainerServiceSkillLine.lua b/api/GetTrainerServiceSkillLine.lua new file mode 100644 index 0000000..4d927e3 --- /dev/null +++ b/api/GetTrainerServiceSkillLine.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string skillLine +---Returns the name of the skill line associated with a trainer service. For trade skill trainers, skill line is the name of the trade skill (e.g. Tailoring, First Aid). For other trainers, skill line is the name of the group header under which the skill appears (e.g. Riding, Frost, Protection, Holy, Defense, Dual Wield). +function GetTrainerServiceSkillLine(index) end \ No newline at end of file diff --git a/api/GetTrainerServiceSkillReq.lua b/api/GetTrainerServiceSkillReq.lua new file mode 100644 index 0000000..5963aee --- /dev/null +++ b/api/GetTrainerServiceSkillReq.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string skill +---@return number rank +---@return 1nil hasReq +---Returns information about the skill requirement for a trainer service. Often used for trade skill recipes: e.g. Netherweave Bag requires Tailoring (315). +function GetTrainerServiceSkillReq(index) end \ No newline at end of file diff --git a/api/GetTrainerServiceStepIndex.lua b/api/GetTrainerServiceStepIndex.lua new file mode 100644 index 0000000..8d630ef --- /dev/null +++ b/api/GetTrainerServiceStepIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetTrainerServiceStepIndex() end \ No newline at end of file diff --git a/api/GetTrainerServiceTypeFilter.lua b/api/GetTrainerServiceTypeFilter.lua new file mode 100644 index 0000000..0dcd2e8 --- /dev/null +++ b/api/GetTrainerServiceTypeFilter.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param type used +---@param available +---@param unavailable +---@param used +---@return 1nil isEnabled +---Returns whether the trainer service listing is filtered by a service status +function GetTrainerServiceTypeFilter(type, available, unavailable, used) end \ No newline at end of file diff --git a/api/GetTrainerTradeskillRankValues.lua b/api/GetTrainerTradeskillRankValues.lua new file mode 100644 index 0000000..fd2cabb --- /dev/null +++ b/api/GetTrainerTradeskillRankValues.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetTrainerTradeskillRankValues() end \ No newline at end of file diff --git a/api/GetTransmogrifyCost.lua b/api/GetTransmogrifyCost.lua new file mode 100644 index 0000000..531acc1 --- /dev/null +++ b/api/GetTransmogrifyCost.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetTransmogrifyCost() end \ No newline at end of file diff --git a/api/GetTransmogrifySlotInfo.lua b/api/GetTransmogrifySlotInfo.lua new file mode 100644 index 0000000..1f1c6ab --- /dev/null +++ b/api/GetTransmogrifySlotInfo.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return boolean isTransmogrified +---@return boolean canTransmogrify +---@return number cannotTransmogrifyReason +---@return boolean hasPending +---@return boolean hasUndo +---@return itemID visibleItemID +---@return textureName textureName +---Return informations about transmogrified items worn by player. +function GetTransmogrifySlotInfo(slot) end \ No newline at end of file diff --git a/api/GetTutorialsEnabled.lua b/api/GetTutorialsEnabled.lua new file mode 100644 index 0000000..204e9cb --- /dev/null +++ b/api/GetTutorialsEnabled.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetTutorialsEnabled() end \ No newline at end of file diff --git a/api/GetUnitHealthModifier.lua b/api/GetUnitHealthModifier.lua new file mode 100644 index 0000000..c7bbb19 --- /dev/null +++ b/api/GetUnitHealthModifier.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return number modifier +---Returns the health modifier for the player's pet +function GetUnitHealthModifier(unit) end \ No newline at end of file diff --git a/api/GetUnitManaRegenRateFromSpirit.lua b/api/GetUnitManaRegenRateFromSpirit.lua new file mode 100644 index 0000000..26e9923 --- /dev/null +++ b/api/GetUnitManaRegenRateFromSpirit.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return number regen +---Returns the increase in mana regeneration rate provided by Spirit +function GetUnitManaRegenRateFromSpirit(unit) end \ No newline at end of file diff --git a/api/GetUnitMaxHealthModifier.lua b/api/GetUnitMaxHealthModifier.lua new file mode 100644 index 0000000..d52265a --- /dev/null +++ b/api/GetUnitMaxHealthModifier.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return number modifier +---Returns the maximum health modifier for the player's pet +function GetUnitMaxHealthModifier(unit) end \ No newline at end of file diff --git a/api/GetUnitName.lua b/api/GetUnitName.lua new file mode 100644 index 0000000..fa94098 --- /dev/null +++ b/api/GetUnitName.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param showServerName boolean +---@return string nameString +---Returns a string summarizing a unit's name and server +function GetUnitName(unit, showServerName) end \ No newline at end of file diff --git a/api/GetUnitPitch.lua b/api/GetUnitPitch.lua new file mode 100644 index 0000000..2c7166f --- /dev/null +++ b/api/GetUnitPitch.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return number pitch +---Returns the player's current pitch (slope or angle of movement). Only valid for the unitID "player". The slope returned here reflects only the direction of movement for swimming or flying, not the current orientation of the player model or camera. (When on solid ground, GetUnitPitch indicates what the angle of flight would be were the player to start flying.) The returned value is in radians, with positive values indicating upward slope, negative values indicating downward slope, and 0 indicating perfectly level flight (or swimming). +function GetUnitPitch(unit) end \ No newline at end of file diff --git a/api/GetUnitPowerModifier.lua b/api/GetUnitPowerModifier.lua new file mode 100644 index 0000000..f9577ab --- /dev/null +++ b/api/GetUnitPowerModifier.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return number modifier +---Returns the mana modifier for the player's pet +function GetUnitPowerModifier(unit) end \ No newline at end of file diff --git a/api/GetUnitSpeed.lua b/api/GetUnitSpeed.lua new file mode 100644 index 0000000..bd65e17 --- /dev/null +++ b/api/GetUnitSpeed.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit unitid +---@return number speed +---@return number groundSpeed +---@return number flightSpeed +---@return number swimSpeed +---Returns a unit's current speed. Valid for all observable units. Values returned indicate the current movement speed in yards per second. (It's not relative to facing or ground position; i.e. you won't see a smaller value when flying up at an angle or a negative value when backing up.) Does not indicate falling speed or the speed of boats, zeppelins, and some forms of quest-related transportation, but does indicate current speed on taxi flights and when moving due to combat effects such as Disengage, Death Grip, or various knockback abilities. Examples (actual results will vary based on terrain, pitch, etc.): Walking: 2.5 Running backwards: 4.5 Normal Running: 7 Ground Mount, 60% speed (Apprentice): 11.2 Ground Mount, 100% speed (Journeyman): 14 Flying Mount, 150% speed (Expert): 17.5 Flying Mount, 280% speed (Artisan): 26.6 Flying Mount, 310% speed (Master): 28.7 Divide the result by BASE_MOVEMENT_SPEED and multiply by 100 to get a percentage of normal run speed. +function GetUnitSpeed(unit) end \ No newline at end of file diff --git a/api/GetVehicleBarIndex.lua b/api/GetVehicleBarIndex.lua new file mode 100644 index 0000000..aa20322 --- /dev/null +++ b/api/GetVehicleBarIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetVehicleBarIndex() end \ No newline at end of file diff --git a/api/GetVehicleUIIndicator.lua b/api/GetVehicleUIIndicator.lua new file mode 100644 index 0000000..8ccb3b4 --- /dev/null +++ b/api/GetVehicleUIIndicator.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetVehicleUIIndicator() end \ No newline at end of file diff --git a/api/GetVehicleUIIndicatorSeat.lua b/api/GetVehicleUIIndicatorSeat.lua new file mode 100644 index 0000000..6340fb1 --- /dev/null +++ b/api/GetVehicleUIIndicatorSeat.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetVehicleUIIndicatorSeat() end \ No newline at end of file diff --git a/api/GetVersatilityBonus.lua b/api/GetVersatilityBonus.lua new file mode 100644 index 0000000..88fe678 --- /dev/null +++ b/api/GetVersatilityBonus.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetVersatilityBonus() end \ No newline at end of file diff --git a/api/GetVideoCaps.lua b/api/GetVideoCaps.lua new file mode 100644 index 0000000..d1d521c --- /dev/null +++ b/api/GetVideoCaps.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number hasAnisotropic +---@return number hasPixelShaders +---@return number hasVertexShaders +---@return number hasTrilinear +---@return number hasTripleBufering +---@return number maxAnisotropy +---@return number hasHardwareCursor +---Returns information about graphics capabilities of the current system +function GetVideoCaps() end \ No newline at end of file diff --git a/api/GetVideoOptions.lua b/api/GetVideoOptions.lua new file mode 100644 index 0000000..c9d6e4c --- /dev/null +++ b/api/GetVideoOptions.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param qualityLevel number +---@return string name +---@return number value +---@return list ... +---Returns video options for different video quality levels. Values greater than 5 will crash the game client. +function GetVideoOptions(qualityLevel) end \ No newline at end of file diff --git a/api/GetVoiceCurrentSessionID.lua b/api/GetVoiceCurrentSessionID.lua new file mode 100644 index 0000000..e72b52d --- /dev/null +++ b/api/GetVoiceCurrentSessionID.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number id +---Returns an identifier for the active voice session +function GetVoiceCurrentSessionID() end \ No newline at end of file diff --git a/api/GetVoiceSessionInfo.lua b/api/GetVoiceSessionInfo.lua new file mode 100644 index 0000000..b1b9f22 --- /dev/null +++ b/api/GetVoiceSessionInfo.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param session number +---@return string name +---@return 1nil active +---Returns information about a voice session +function GetVoiceSessionInfo(session) end \ No newline at end of file diff --git a/api/GetVoiceSessionMemberInfoBySessionID.lua b/api/GetVoiceSessionMemberInfoBySessionID.lua new file mode 100644 index 0000000..5e8f66d --- /dev/null +++ b/api/GetVoiceSessionMemberInfoBySessionID.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param session number +---@param index number +---@return string name +---@return 1nil voiceActive +---@return 1nil sessionActive +---@return 1nil muted +---@return 1nil squelched +---Returns information about a member of a voice channel +function GetVoiceSessionMemberInfoBySessionID(session, index) end \ No newline at end of file diff --git a/api/GetVoiceStatus.lua b/api/GetVoiceStatus.lua new file mode 100644 index 0000000..1d6116c --- /dev/null +++ b/api/GetVoiceStatus.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit unitid +---@param name string +---@param channel string +---@return 1nil status +---Returns whether a character has voice chat enabled +function GetVoiceStatus(unit, name, channel) end \ No newline at end of file diff --git a/api/GetVoidItemHyperlinkString.lua b/api/GetVoidItemHyperlinkString.lua new file mode 100644 index 0000000..92b1a6a --- /dev/null +++ b/api/GetVoidItemHyperlinkString.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetVoidItemHyperlinkString() end \ No newline at end of file diff --git a/api/GetVoidItemInfo.lua b/api/GetVoidItemInfo.lua new file mode 100644 index 0000000..fd832fb --- /dev/null +++ b/api/GetVoidItemInfo.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param tab number +---@param slot number +---@return number itemID +---@return number texture +---@return boolean locked +---@return boolean recentDeposit +---@return boolean isFiltered +---@return number quality +---Returns item info for the given void storage slot. Will only return data when IsVoidStorageReady returns true. +function GetVoidItemInfo(tab, slot) end \ No newline at end of file diff --git a/api/GetVoidStorageSlotPageIndex.lua b/api/GetVoidStorageSlotPageIndex.lua new file mode 100644 index 0000000..a9c964b --- /dev/null +++ b/api/GetVoidStorageSlotPageIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetVoidStorageSlotPageIndex() end \ No newline at end of file diff --git a/api/GetVoidTransferCost.lua b/api/GetVoidTransferCost.lua new file mode 100644 index 0000000..7fab5a6 --- /dev/null +++ b/api/GetVoidTransferCost.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetVoidTransferCost() end \ No newline at end of file diff --git a/api/GetVoidTransferDepositInfo.lua b/api/GetVoidTransferDepositInfo.lua new file mode 100644 index 0000000..50dd610 --- /dev/null +++ b/api/GetVoidTransferDepositInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetVoidTransferDepositInfo() end \ No newline at end of file diff --git a/api/GetVoidTransferWithdrawalInfo.lua b/api/GetVoidTransferWithdrawalInfo.lua new file mode 100644 index 0000000..f6c0e82 --- /dev/null +++ b/api/GetVoidTransferWithdrawalInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetVoidTransferWithdrawalInfo() end \ No newline at end of file diff --git a/api/GetVoidUnlockCost.lua b/api/GetVoidUnlockCost.lua new file mode 100644 index 0000000..10755ad --- /dev/null +++ b/api/GetVoidUnlockCost.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetVoidUnlockCost() end \ No newline at end of file diff --git a/api/GetWarGameQueueStatus.lua b/api/GetWarGameQueueStatus.lua new file mode 100644 index 0000000..822bd4b --- /dev/null +++ b/api/GetWarGameQueueStatus.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetWarGameQueueStatus() end \ No newline at end of file diff --git a/api/GetWarGameTypeInfo.lua b/api/GetWarGameTypeInfo.lua new file mode 100644 index 0000000..7d56a49 --- /dev/null +++ b/api/GetWarGameTypeInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetWarGameTypeInfo() end \ No newline at end of file diff --git a/api/GetWatchedFactionInfo.lua b/api/GetWatchedFactionInfo.lua new file mode 100644 index 0000000..d598452 --- /dev/null +++ b/api/GetWatchedFactionInfo.lua @@ -0,0 +1,17 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string name +---@return 8 standingID +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---@return 5 +---@return 6 +---@return 7 +---@return 8 +---@return number barMin +---@return number barMax +---@return number barValue +---Returns information about the "watched" faction (displayed on the XP bar in the default UI) +function GetWatchedFactionInfo() end \ No newline at end of file diff --git a/api/GetWeaponEnchantInfo.lua b/api/GetWeaponEnchantInfo.lua new file mode 100644 index 0000000..36e2be1 --- /dev/null +++ b/api/GetWeaponEnchantInfo.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil hasMainHandEnchant +---@return number mainHandExpiration +---@return number mainHandCharges +---@return 1nil hasOffHandEnchant +---@return number offHandExpiration +---@return number offHandCharges +---Returns information about temporary enchantments on the player's weapons. Does not return information about permanent enchantments added via Enchanting, Runeforging, etc; refers instead to temporary buffs such as wizard oils, sharpening stones, rogue poisons, and shaman weapon enhancements. +function GetWeaponEnchantInfo() end \ No newline at end of file diff --git a/api/GetWhoInfo.lua b/api/GetWhoInfo.lua new file mode 100644 index 0000000..51b03e3 --- /dev/null +++ b/api/GetWhoInfo.lua @@ -0,0 +1,15 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---@return string guild +---@return number level +---@return string race +---@return string class +---@return string zone +---@return string classFileName +---@return 3 sex +---@return 2 +---@return 3 +---Returns information about a character in the Who system query results +function GetWhoInfo(index) end \ No newline at end of file diff --git a/api/GetWorldElapsedTime.lua b/api/GetWorldElapsedTime.lua new file mode 100644 index 0000000..d40652f --- /dev/null +++ b/api/GetWorldElapsedTime.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetWorldElapsedTime() end \ No newline at end of file diff --git a/api/GetWorldElapsedTimers.lua b/api/GetWorldElapsedTimers.lua new file mode 100644 index 0000000..145e729 --- /dev/null +++ b/api/GetWorldElapsedTimers.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetWorldElapsedTimers() end \ No newline at end of file diff --git a/api/GetWorldLocFromMapPos.lua b/api/GetWorldLocFromMapPos.lua new file mode 100644 index 0000000..a35d2c2 --- /dev/null +++ b/api/GetWorldLocFromMapPos.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetWorldLocFromMapPos() end \ No newline at end of file diff --git a/api/GetWorldMapTransformInfo.lua b/api/GetWorldMapTransformInfo.lua new file mode 100644 index 0000000..560063d --- /dev/null +++ b/api/GetWorldMapTransformInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetWorldMapTransformInfo() end \ No newline at end of file diff --git a/api/GetWorldMapTransforms.lua b/api/GetWorldMapTransforms.lua new file mode 100644 index 0000000..eaf2982 --- /dev/null +++ b/api/GetWorldMapTransforms.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GetWorldMapTransforms() end \ No newline at end of file diff --git a/api/GetWorldPVPAreaInfo.lua b/api/GetWorldPVPAreaInfo.lua new file mode 100644 index 0000000..5f2d6cd --- /dev/null +++ b/api/GetWorldPVPAreaInfo.lua @@ -0,0 +1,13 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param pvpMapID 2 +---@param 1 +---@param 2 +---@return number pvpID +---@return string localizedName +---@return boolean isActive +---@return boolean canQueue +---@return number waitTime +---@return boolean canEnter +---Returns information about a given world PvP zone +function GetWorldPVPAreaInfo(pvpMapID, 1, 2) end \ No newline at end of file diff --git a/api/GetWorldPVPQueueStatus.lua b/api/GetWorldPVPQueueStatus.lua new file mode 100644 index 0000000..6f8f8b3 --- /dev/null +++ b/api/GetWorldPVPQueueStatus.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return queued status +---@return confirm +---@return none +---@return queued +---@return string mapName +---@return number queueID +---Returns information on the players queue for a world PvP zone +function GetWorldPVPQueueStatus(index) end \ No newline at end of file diff --git a/api/GetWorldStateUIInfo.lua b/api/GetWorldStateUIInfo.lua new file mode 100644 index 0000000..f10f3b3 --- /dev/null +++ b/api/GetWorldStateUIInfo.lua @@ -0,0 +1,19 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number uiType +---@return number state +---@return boolean hidden +---@return string text +---@return string icon +---@return string dynamicIcon +---@return string tooltip +---@return string dynamicTooltip +---@return "CAPTUREPOINT" extendedUI +---@return "" +---@return "CAPTUREPOINT" +---@return number extendedUIState1 +---@return number extendedUIState2 +---@return number extendedUIState3 +---Returns information about a world state UI element. World State UI elements include PvP, instance, and quest objective information (displayed at the top center of the screen in the default UI) as well as more specific information for "control point" style PvP objectives. Examples: the Horde/Alliance score in Arathi Basin, the tower status and capture progress bars in Hellfire Peninsula, the progress text in the Black Morass and Violet Hold instances, and the event status text for quests The Light of Dawn and The Battle For The Undercity. +function GetWorldStateUIInfo(index) end \ No newline at end of file diff --git a/api/GetXPExhaustion.lua b/api/GetXPExhaustion.lua new file mode 100644 index 0000000..1512f8a --- /dev/null +++ b/api/GetXPExhaustion.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number exhaustionXP +---Returns the amount of rested bonus experience available. This value increments as the player spends time resting and depletes as the player earns experience from kills while rested. +function GetXPExhaustion() end \ No newline at end of file diff --git a/api/GetZonePVPInfo.lua b/api/GetZonePVPInfo.lua new file mode 100644 index 0000000..fe6e260 --- /dev/null +++ b/api/GetZonePVPInfo.lua @@ -0,0 +1,14 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return sanctuary pvpType +---@return arena +---@return combat +---@return contested +---@return friendly +---@return hostile +---@return nil +---@return sanctuary +---@return 1nil isSubZonePVP +---@return string factionName +---Returns PVP information about the current area. Information returned may apply to the current subzone, not the entire zone. +function GetZonePVPInfo() end \ No newline at end of file diff --git a/api/GetZoneText.lua b/api/GetZoneText.lua new file mode 100644 index 0000000..99b1b59 --- /dev/null +++ b/api/GetZoneText.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string zone +---Returns the name of the zone in which the player is located +function GetZoneText() end \ No newline at end of file diff --git a/api/GiveMasterLoot.lua b/api/GiveMasterLoot.lua new file mode 100644 index 0000000..dd6d695 --- /dev/null +++ b/api/GiveMasterLoot.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@param index number +---Awards a loot item to a group member. Has no effect if the player is not the loot master or if no loot or candidate matching the given parameters exists. +function GiveMasterLoot(slot, index) end \ No newline at end of file diff --git a/api/GlyphMatchesSocket.lua b/api/GlyphMatchesSocket.lua new file mode 100644 index 0000000..273cf27 --- /dev/null +++ b/api/GlyphMatchesSocket.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param socket number +---@return 1nil match +---Returns whether a socket is eligible for the glyph currently awaiting a target. Only valid during glyph application: when the player has activated the glyph item but before she has chosen the glyph slot to put it in (i.e. the glowing hand cursor is showing). +function GlyphMatchesSocket(socket) end \ No newline at end of file diff --git a/api/GrantLevel.lua b/api/GrantLevel.lua new file mode 100644 index 0000000..56f15ea --- /dev/null +++ b/api/GrantLevel.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---Grants a level to the player's Recruit-a-Friend partner. Does not immediately cause the partner character to level up: that player is given a chance to accept or decline the offered level. +function GrantLevel(unit) end \ No newline at end of file diff --git a/api/GuildControlAddRank.lua b/api/GuildControlAddRank.lua new file mode 100644 index 0000000..0c82287 --- /dev/null +++ b/api/GuildControlAddRank.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---Adds a new rank to the player's guild. The newly added rank becomes the lowest rank in the guild. +function GuildControlAddRank(name) end \ No newline at end of file diff --git a/api/GuildControlDelRank.lua b/api/GuildControlDelRank.lua new file mode 100644 index 0000000..7dceb82 --- /dev/null +++ b/api/GuildControlDelRank.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---Deletes a guild rank +function GuildControlDelRank(name) end \ No newline at end of file diff --git a/api/GuildControlGetAllowedShifts.lua b/api/GuildControlGetAllowedShifts.lua new file mode 100644 index 0000000..5ede0d1 --- /dev/null +++ b/api/GuildControlGetAllowedShifts.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GuildControlGetAllowedShifts() end \ No newline at end of file diff --git a/api/GuildControlGetNumRanks.lua b/api/GuildControlGetNumRanks.lua new file mode 100644 index 0000000..67e3c41 --- /dev/null +++ b/api/GuildControlGetNumRanks.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numRanks +---Returns the number of ranks in the guild +function GuildControlGetNumRanks() end \ No newline at end of file diff --git a/api/GuildControlGetRankFlags.lua b/api/GuildControlGetRankFlags.lua new file mode 100644 index 0000000..5cf6ba4 --- /dev/null +++ b/api/GuildControlGetRankFlags.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return list ... +---Returns the list of privileges for the guild rank being edited. The name of a privilege for an index in this list can be found in the global variable "GUILDCONTROL_OPTION"..index. +function GuildControlGetRankFlags() end \ No newline at end of file diff --git a/api/GuildControlGetRankName.lua b/api/GuildControlGetRankName.lua new file mode 100644 index 0000000..f3411d0 --- /dev/null +++ b/api/GuildControlGetRankName.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param rank number +---@return string rankName +---Returns the name of a guild rank +function GuildControlGetRankName(rank) end \ No newline at end of file diff --git a/api/GuildControlSaveRank.lua b/api/GuildControlSaveRank.lua new file mode 100644 index 0000000..d20a1b8 --- /dev/null +++ b/api/GuildControlSaveRank.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---Saves changes to the guild rank being edited +function GuildControlSaveRank(name) end \ No newline at end of file diff --git a/api/GuildControlSetRank.lua b/api/GuildControlSetRank.lua new file mode 100644 index 0000000..fefb2c8 --- /dev/null +++ b/api/GuildControlSetRank.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param rank number +---Chooses a guild rank to edit +function GuildControlSetRank(rank) end \ No newline at end of file diff --git a/api/GuildControlSetRankFlag.lua b/api/GuildControlSetRankFlag.lua new file mode 100644 index 0000000..8f85dfe --- /dev/null +++ b/api/GuildControlSetRankFlag.lua @@ -0,0 +1,22 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index 17 +---@param 1 +---@param 2 +---@param 3 +---@param 4 +---@param 5 +---@param 6 +---@param 7 +---@param 8 +---@param 9 +---@param 10 +---@param 11 +---@param 12 +---@param 13 +---@param 15 +---@param 16 +---@param 17 +---@param enabled boolean +---Enables or disables a privilege for the guild rank being edited. Changes are not saved until a call is made to GuildControlSaveRank(). +function GuildControlSetRankFlag(index, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 15, 16, 17, enabled) end \ No newline at end of file diff --git a/api/GuildControlShiftRankDown.lua b/api/GuildControlShiftRankDown.lua new file mode 100644 index 0000000..60fd7d9 --- /dev/null +++ b/api/GuildControlShiftRankDown.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GuildControlShiftRankDown() end \ No newline at end of file diff --git a/api/GuildControlShiftRankUp.lua b/api/GuildControlShiftRankUp.lua new file mode 100644 index 0000000..6bfaccf --- /dev/null +++ b/api/GuildControlShiftRankUp.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GuildControlShiftRankUp() end \ No newline at end of file diff --git a/api/GuildDemote.lua b/api/GuildDemote.lua new file mode 100644 index 0000000..b53daf0 --- /dev/null +++ b/api/GuildDemote.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---Reduces a guild member's rank by one. The player can only demote members whose rank is below the player's own, and only if the player has permission to demote (i.e. if CanGuildDemote() returns 1). +function GuildDemote(name) end \ No newline at end of file diff --git a/api/GuildDisband.lua b/api/GuildDisband.lua new file mode 100644 index 0000000..1fe04b3 --- /dev/null +++ b/api/GuildDisband.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Disbands the player's guild. Only has effect if the player is the guild leader +function GuildDisband() end \ No newline at end of file diff --git a/api/GuildInfo.lua b/api/GuildInfo.lua new file mode 100644 index 0000000..0569cf1 --- /dev/null +++ b/api/GuildInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Requests guild information from the server. Fires two CHAT_MSG_SYSTEM events, one containing the name of the guild, followed by one containing the date the guild was created and how many players and accounts belong to the guild. +function GuildInfo() end \ No newline at end of file diff --git a/api/GuildInvite.lua b/api/GuildInvite.lua new file mode 100644 index 0000000..40f13e9 --- /dev/null +++ b/api/GuildInvite.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---Invites a character to join the player's guild +function GuildInvite(name) end \ No newline at end of file diff --git a/api/GuildLeave.lua b/api/GuildLeave.lua new file mode 100644 index 0000000..5a7d71c --- /dev/null +++ b/api/GuildLeave.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Leaves the player's current guild +function GuildLeave() end \ No newline at end of file diff --git a/api/GuildMasterAbsent.lua b/api/GuildMasterAbsent.lua new file mode 100644 index 0000000..85f3bd1 --- /dev/null +++ b/api/GuildMasterAbsent.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GuildMasterAbsent() end \ No newline at end of file diff --git a/api/GuildNewsSetSticky.lua b/api/GuildNewsSetSticky.lua new file mode 100644 index 0000000..2f92bfa --- /dev/null +++ b/api/GuildNewsSetSticky.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GuildNewsSetSticky() end \ No newline at end of file diff --git a/api/GuildNewsSort.lua b/api/GuildNewsSort.lua new file mode 100644 index 0000000..eb42d23 --- /dev/null +++ b/api/GuildNewsSort.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GuildNewsSort() end \ No newline at end of file diff --git a/api/GuildPromote.lua b/api/GuildPromote.lua new file mode 100644 index 0000000..221c05b --- /dev/null +++ b/api/GuildPromote.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---Increases a guild member's rank by one. The player can only promote members up to the rank immediately below the player's own, and only if the player has permission to promote (i.e. if CanGuildPromote() returns 1). +function GuildPromote(name) end \ No newline at end of file diff --git a/api/GuildRoster.lua b/api/GuildRoster.lua new file mode 100644 index 0000000..bd2c198 --- /dev/null +++ b/api/GuildRoster.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Requests guild roster information from the server. Information is not returned immediately; the GUILD_ROSTER_UPDATE event fires when data is available for retrieval via GetGuildRosterInfo() and related functions. Requests are throttled to reduce server load; the server will only respond to a new request approximately 10 seconds after a previous request. +function GuildRoster() end \ No newline at end of file diff --git a/api/GuildRosterSendSoR.lua b/api/GuildRosterSendSoR.lua new file mode 100644 index 0000000..b2b340a --- /dev/null +++ b/api/GuildRosterSendSoR.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function GuildRosterSendSoR() end \ No newline at end of file diff --git a/api/GuildRosterSetOfficerNote.lua b/api/GuildRosterSetOfficerNote.lua new file mode 100644 index 0000000..147a4b3 --- /dev/null +++ b/api/GuildRosterSetOfficerNote.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param note string +---Sets the officer note for a guild member +function GuildRosterSetOfficerNote(index, note) end \ No newline at end of file diff --git a/api/GuildRosterSetPublicNote.lua b/api/GuildRosterSetPublicNote.lua new file mode 100644 index 0000000..ead685c --- /dev/null +++ b/api/GuildRosterSetPublicNote.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param note string +---Sets the public note for a guild member +function GuildRosterSetPublicNote(index, note) end \ No newline at end of file diff --git a/api/GuildSetLeader.lua b/api/GuildSetLeader.lua new file mode 100644 index 0000000..22731da --- /dev/null +++ b/api/GuildSetLeader.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---Promotes a member to guild leader. Only works if the player is the guild leader and the named character is in the guild and currently online. +function GuildSetLeader(name) end \ No newline at end of file diff --git a/api/GuildSetMOTD.lua b/api/GuildSetMOTD.lua new file mode 100644 index 0000000..bfff5e7 --- /dev/null +++ b/api/GuildSetMOTD.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param message string +---Sets the guild Message of the Day. Guild members see the message of the day upon login and whenever it is changed (and cannot disable its display in the default UI), so keeping the message concise is recommended. +function GuildSetMOTD(message) end \ No newline at end of file diff --git a/api/GuildUninvite.lua b/api/GuildUninvite.lua new file mode 100644 index 0000000..a8a3896 --- /dev/null +++ b/api/GuildUninvite.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---Removes a character from the player's guild +function GuildUninvite(name) end \ No newline at end of file diff --git a/api/HasAPEffectsSpellPower.lua b/api/HasAPEffectsSpellPower.lua new file mode 100644 index 0000000..3739fdc --- /dev/null +++ b/api/HasAPEffectsSpellPower.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function HasAPEffectsSpellPower() end \ No newline at end of file diff --git a/api/HasAction.lua b/api/HasAction.lua new file mode 100644 index 0000000..ff3ecdc --- /dev/null +++ b/api/HasAction.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return 1nil hasAction +---Returns whether an action slot contains an action +function HasAction(slot) end \ No newline at end of file diff --git a/api/HasBonusActionBar.lua b/api/HasBonusActionBar.lua new file mode 100644 index 0000000..9a4f658 --- /dev/null +++ b/api/HasBonusActionBar.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function HasBonusActionBar() end \ No newline at end of file diff --git a/api/HasCompletedAnyAchievement.lua b/api/HasCompletedAnyAchievement.lua new file mode 100644 index 0000000..87f95a1 --- /dev/null +++ b/api/HasCompletedAnyAchievement.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean state +---Checks if the player has completed at least 1 achievement. Used to determine whether or not the achievements frame should be loaded, and if the Achievements button on the micro menu should be enabled or not. +function HasCompletedAnyAchievement() end \ No newline at end of file diff --git a/api/HasDebugZoneMap.lua b/api/HasDebugZoneMap.lua new file mode 100644 index 0000000..a208454 --- /dev/null +++ b/api/HasDebugZoneMap.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function HasDebugZoneMap() end \ No newline at end of file diff --git a/api/HasDraenorZoneAbility.lua b/api/HasDraenorZoneAbility.lua new file mode 100644 index 0000000..e4cf073 --- /dev/null +++ b/api/HasDraenorZoneAbility.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function HasDraenorZoneAbility() end \ No newline at end of file diff --git a/api/HasExtraActionBar.lua b/api/HasExtraActionBar.lua new file mode 100644 index 0000000..d538c29 --- /dev/null +++ b/api/HasExtraActionBar.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function HasExtraActionBar() end \ No newline at end of file diff --git a/api/HasFullControl.lua b/api/HasFullControl.lua new file mode 100644 index 0000000..d5a8aa8 --- /dev/null +++ b/api/HasFullControl.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil hasControl +---Returns whether the player character can be controlled +function HasFullControl() end \ No newline at end of file diff --git a/api/HasInspectHonorData.lua b/api/HasInspectHonorData.lua new file mode 100644 index 0000000..b9d2464 --- /dev/null +++ b/api/HasInspectHonorData.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil hasData +---Returns whether PvP honor and arena data for the currently inspected unit has been downloaded from the server. See RequestInspectHonorData() to request PvP data from the server. +function HasInspectHonorData() end \ No newline at end of file diff --git a/api/HasKey.lua b/api/HasKey.lua new file mode 100644 index 0000000..ec9de25 --- /dev/null +++ b/api/HasKey.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil hasKey +---Returns whether the player has any keys stored in the Keyring container. Used in the default UI to show or hide the UI for the Keyring container +function HasKey() end \ No newline at end of file diff --git a/api/HasLFGRestrictions.lua b/api/HasLFGRestrictions.lua new file mode 100644 index 0000000..12b33d4 --- /dev/null +++ b/api/HasLFGRestrictions.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function HasLFGRestrictions() end \ No newline at end of file diff --git a/api/HasNewMail.lua b/api/HasNewMail.lua new file mode 100644 index 0000000..ecc466f --- /dev/null +++ b/api/HasNewMail.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil hasMail +---Returns whether the player has received new mail since last visiting a mailbox +function HasNewMail() end \ No newline at end of file diff --git a/api/HasOverrideActionBar.lua b/api/HasOverrideActionBar.lua new file mode 100644 index 0000000..396843b --- /dev/null +++ b/api/HasOverrideActionBar.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function HasOverrideActionBar() end \ No newline at end of file diff --git a/api/HasPetSpells.lua b/api/HasPetSpells.lua new file mode 100644 index 0000000..fc7f493 --- /dev/null +++ b/api/HasPetSpells.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil hasPetSpells +---@return PET petType +---@return DEMON +---@return PET +---Returns whether the player's current pet has a spellbook +function HasPetSpells() end \ No newline at end of file diff --git a/api/HasPetUI.lua b/api/HasPetUI.lua new file mode 100644 index 0000000..a34e4e0 --- /dev/null +++ b/api/HasPetUI.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil hasPetUI +---@return 1nil isHunterPet +---Returns whether the pet UI should be displayed for the player's pet. Special quest-related pets, vehicles, and possessed units all count as pets but do not use the pet UI or associated functions. +function HasPetUI() end \ No newline at end of file diff --git a/api/HasSPEffectsAttackPower.lua b/api/HasSPEffectsAttackPower.lua new file mode 100644 index 0000000..4deb394 --- /dev/null +++ b/api/HasSPEffectsAttackPower.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function HasSPEffectsAttackPower() end \ No newline at end of file diff --git a/api/HasSoulstone.lua b/api/HasSoulstone.lua new file mode 100644 index 0000000..3f4a0e1 --- /dev/null +++ b/api/HasSoulstone.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string text +---Returns whether the player can instantly resurrect in place. Only returns valid information while the player is dead and has not yet released his or her spirit to the graveyard. +function HasSoulstone() end \ No newline at end of file diff --git a/api/HasTempShapeshiftActionBar.lua b/api/HasTempShapeshiftActionBar.lua new file mode 100644 index 0000000..e40a30c --- /dev/null +++ b/api/HasTempShapeshiftActionBar.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function HasTempShapeshiftActionBar() end \ No newline at end of file diff --git a/api/HasVehicleActionBar.lua b/api/HasVehicleActionBar.lua new file mode 100644 index 0000000..e22dd18 --- /dev/null +++ b/api/HasVehicleActionBar.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function HasVehicleActionBar() end \ No newline at end of file diff --git a/api/HasWandEquipped.lua b/api/HasWandEquipped.lua new file mode 100644 index 0000000..20239ac --- /dev/null +++ b/api/HasWandEquipped.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isEquipped +---Returns whether the player has a wand equipped +function HasWandEquipped() end \ No newline at end of file diff --git a/api/HaveQuestData.lua b/api/HaveQuestData.lua new file mode 100644 index 0000000..1497b37 --- /dev/null +++ b/api/HaveQuestData.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function HaveQuestData() end \ No newline at end of file diff --git a/api/HearthAndResurrectFromArea.lua b/api/HearthAndResurrectFromArea.lua new file mode 100644 index 0000000..6c1ad14 --- /dev/null +++ b/api/HearthAndResurrectFromArea.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Instantly exits the current world PvP zone, returning to the player's Hearthstone location. Resets the player's Hearthstone cooldown, and also returns the player to life if dead. Only usable if the player is in a world PvP combat zone (i.e. Wintergrasp). +function HearthAndResurrectFromArea() end \ No newline at end of file diff --git a/api/HideRepairCursor.lua b/api/HideRepairCursor.lua new file mode 100644 index 0000000..5b6ae6b --- /dev/null +++ b/api/HideRepairCursor.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Returns the cursor to normal mode after use of ShowRepairCursor() +function HideRepairCursor() end \ No newline at end of file diff --git a/api/InActiveBattlefield.lua b/api/InActiveBattlefield.lua new file mode 100644 index 0000000..7d89f05 --- /dev/null +++ b/api/InActiveBattlefield.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function InActiveBattlefield() end \ No newline at end of file diff --git a/api/InCinematic.lua b/api/InCinematic.lua new file mode 100644 index 0000000..2139d11 --- /dev/null +++ b/api/InCinematic.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil inCinematic +---Returns whether an in-game cinematic is playing. Applies to in-game-engine cinematics (such as when logging into a new character for the first time), not prerecorded movies. +function InCinematic() end \ No newline at end of file diff --git a/api/InCombatLockdown.lua b/api/InCombatLockdown.lua new file mode 100644 index 0000000..798ab0f --- /dev/null +++ b/api/InCombatLockdown.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil inLockdown +---Returns whether the user interface is protected due to combat. Non-Blizzard code is allowed to perform certain UI actions (such as changing secure template attributes or moving/showing/hiding secure frames) only if the player is not in combat; this function can be used to determine whether such actions are currently available. +function InCombatLockdown() end \ No newline at end of file diff --git a/api/InGuildParty.lua b/api/InGuildParty.lua new file mode 100644 index 0000000..25112d1 --- /dev/null +++ b/api/InGuildParty.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean inGroup +---@return number numGuildPresent +---@return number numGuildRequired +---@return number xpMultiplier +---Returns whether or not player is in a guild party. +function InGuildParty() end \ No newline at end of file diff --git a/api/InRepairMode.lua b/api/InRepairMode.lua new file mode 100644 index 0000000..38d8f69 --- /dev/null +++ b/api/InRepairMode.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil inRepair +---Returns whether the item repair cursor mode is currently active. Repair mode is entered by calling ShowRepairCursor() and exited by calling HideRepairCursor(); while in repair mode, calling PickupContainerItem() or PickupInventoryItem() will attempt to repair the item (and deduct the cost of such from the player's savings) instead of putting it on the cursor. +function InRepairMode() end \ No newline at end of file diff --git a/api/InboxItemCanDelete.lua b/api/InboxItemCanDelete.lua new file mode 100644 index 0000000..af335bf --- /dev/null +++ b/api/InboxItemCanDelete.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param mailID number +---@return 1nil canDelete +---Returns whether a message in the player's inbox can be deleted +function InboxItemCanDelete(mailID) end \ No newline at end of file diff --git a/api/InitWorldMapPing.lua b/api/InitWorldMapPing.lua new file mode 100644 index 0000000..0662efa --- /dev/null +++ b/api/InitWorldMapPing.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Initializes the frame used to display the character location "ping" on the World Map +function InitWorldMapPing() end \ No newline at end of file diff --git a/api/InitiateRolePoll.lua b/api/InitiateRolePoll.lua new file mode 100644 index 0000000..f1bd092 --- /dev/null +++ b/api/InitiateRolePoll.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean success +---Initiates a raid-wide role check. Every raid member is required to set his own role in a popup role window. +function InitiateRolePoll() end \ No newline at end of file diff --git a/api/InitiateTrade.lua b/api/InitiateTrade.lua new file mode 100644 index 0000000..d8d462b --- /dev/null +++ b/api/InitiateTrade.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---Offers to trade with a given unit. The trade process does not begin immediately; once the server has determined both clients can trade, the TRADE_SHOW event fires. +function InitiateTrade(unit, name) end \ No newline at end of file diff --git a/api/InteractUnit.lua b/api/InteractUnit.lua new file mode 100644 index 0000000..25104c1 --- /dev/null +++ b/api/InteractUnit.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit unitid +---Interacts with (as with right-clicking on) a unit +function InteractUnit(unit) end \ No newline at end of file diff --git a/api/InterfaceOptionsFrame_OpenToCategory.lua b/api/InterfaceOptionsFrame_OpenToCategory.lua new file mode 100644 index 0000000..31730be --- /dev/null +++ b/api/InterfaceOptionsFrame_OpenToCategory.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param panelName string +---@param panel table +---Opens the Interface Options window and displays a given panel within it +function InterfaceOptionsFrame_OpenToCategory(panelName, panel) end \ No newline at end of file diff --git a/api/InterfaceOptions_AddCategory.lua b/api/InterfaceOptions_AddCategory.lua new file mode 100644 index 0000000..d2f4981 --- /dev/null +++ b/api/InterfaceOptions_AddCategory.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param panel table +---Registers a panel to be displayed in the Interface Options window. The following members and methods are used by the Interface Options frame to display and organize panels: panel.name - string (required) - The name of the AddOn or group of configuration options. This is the text that will display in the AddOn options list. panel.parent - string (optional) - Name of the parent of the AddOn or group of configuration options. This identifies "panel" as the child of another category. If the parent category doesn't exist, "panel" will be displayed as a regular category. panel.okay - function (optional) - This method will run when the player clicks "okay" in the Interface Options. panel.cancel - function (optional) - This method will run when the player clicks "cancel" in the Interface Options. Use this to revert their changes. panel.default - function (optional) - This method will run when the player clicks "defaults". Use this to revert their changes to your defaults. panel.refresh - function (optional) - This method will run when the Interface Options frame calls its OnShow function and after defaults have been applied via the panel.default method described above. Use this to refresh your panel's UI in case settings were changed without player interaction. +function InterfaceOptions_AddCategory(panel) end \ No newline at end of file diff --git a/api/InviteUnit.lua b/api/InviteUnit.lua new file mode 100644 index 0000000..e8e7c9b --- /dev/null +++ b/api/InviteUnit.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---Invites a character to the player's party or raid +function InviteUnit(name) end \ No newline at end of file diff --git a/api/IsAchievementEligible.lua b/api/IsAchievementEligible.lua new file mode 100644 index 0000000..bdc4c68 --- /dev/null +++ b/api/IsAchievementEligible.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsAchievementEligible() end \ No newline at end of file diff --git a/api/IsActionInRange.lua b/api/IsActionInRange.lua new file mode 100644 index 0000000..f855cac --- /dev/null +++ b/api/IsActionInRange.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@param unit string +---@return number inRange +---Returns whether the player's target is in range of an action +function IsActionInRange(slot, unit) end \ No newline at end of file diff --git a/api/IsActiveBattlefieldArena.lua b/api/IsActiveBattlefieldArena.lua new file mode 100644 index 0000000..86b6ea4 --- /dev/null +++ b/api/IsActiveBattlefieldArena.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isArena +---@return 1nil isRegistered +---Returns whether the player is currently in an arena match +function IsActiveBattlefieldArena() end \ No newline at end of file diff --git a/api/IsActiveQuestLegendary.lua b/api/IsActiveQuestLegendary.lua new file mode 100644 index 0000000..6cc9457 --- /dev/null +++ b/api/IsActiveQuestLegendary.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsActiveQuestLegendary() end \ No newline at end of file diff --git a/api/IsActiveQuestTrivial.lua b/api/IsActiveQuestTrivial.lua new file mode 100644 index 0000000..2f60693 --- /dev/null +++ b/api/IsActiveQuestTrivial.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return 1nil trivial +---Returns whether a quest which can be turned in to the current Quest NPC is trivial at the player's level. Only returns valid information after a QUEST_GREETING event. Used in the default UI to display "(low level)" when listing the quest. Note: Most quest NPCs present active quests using the GetGossipActiveQuests() instead of this function. +function IsActiveQuestTrivial(index) end \ No newline at end of file diff --git a/api/IsAddOnLoadOnDemand.lua b/api/IsAddOnLoadOnDemand.lua new file mode 100644 index 0000000..dc50bac --- /dev/null +++ b/api/IsAddOnLoadOnDemand.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param index number +---@return 1nil isLod +---Returns whether an addon can be loaded without restarting the UI +function IsAddOnLoadOnDemand(name, index) end \ No newline at end of file diff --git a/api/IsAddOnLoaded.lua b/api/IsAddOnLoaded.lua new file mode 100644 index 0000000..23e9ef0 --- /dev/null +++ b/api/IsAddOnLoaded.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param index number +---@return 1nil loaded +---Returns whether an addon is currently loaded +function IsAddOnLoaded(name, index) end \ No newline at end of file diff --git a/api/IsAddonMessagePrefixRegistered.lua b/api/IsAddonMessagePrefixRegistered.lua new file mode 100644 index 0000000..e148547 --- /dev/null +++ b/api/IsAddonMessagePrefixRegistered.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param prefix string +---@return boolean isRegistered +---Returns whether or not the client has registered to receive messages with a given addon prefix +function IsAddonMessagePrefixRegistered(prefix) end \ No newline at end of file diff --git a/api/IsAddonVersionCheckEnabled.lua b/api/IsAddonVersionCheckEnabled.lua new file mode 100644 index 0000000..820a614 --- /dev/null +++ b/api/IsAddonVersionCheckEnabled.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsAddonVersionCheckEnabled() end \ No newline at end of file diff --git a/api/IsAltKeyDown.lua b/api/IsAltKeyDown.lua new file mode 100644 index 0000000..7b1d4f7 --- /dev/null +++ b/api/IsAltKeyDown.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return true/false isDown +---Returns whether an Alt key on the keyboard is held down. +function IsAltKeyDown() end \ No newline at end of file diff --git a/api/IsArenaSkirmish.lua b/api/IsArenaSkirmish.lua new file mode 100644 index 0000000..08529ad --- /dev/null +++ b/api/IsArenaSkirmish.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsArenaSkirmish() end \ No newline at end of file diff --git a/api/IsArenaTeamCaptain.lua b/api/IsArenaTeamCaptain.lua new file mode 100644 index 0000000..6669fb6 --- /dev/null +++ b/api/IsArenaTeamCaptain.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param team number +---@return 1nil isCaptain +---Returns whether the player is the captain of an arena team. Also returns 1 if the player is not on a team of the given arenaTeamID. +function IsArenaTeamCaptain(team) end \ No newline at end of file diff --git a/api/IsArtifactCompletionHistoryAvailable.lua b/api/IsArtifactCompletionHistoryAvailable.lua new file mode 100644 index 0000000..e58bea3 --- /dev/null +++ b/api/IsArtifactCompletionHistoryAvailable.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsArtifactCompletionHistoryAvailable() end \ No newline at end of file diff --git a/api/IsAtStableMaster.lua b/api/IsAtStableMaster.lua new file mode 100644 index 0000000..c38fdc5 --- /dev/null +++ b/api/IsAtStableMaster.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean isAtNPC +---Returns whether the player is interacting with a Stable Master NPC. The Pet Stable UI/API can be active without an NPC if the player is using the Call Stabled Pet ability. New stable slots can only be purchased while talking to an NPC -- the default UI uses this function to determine whether to show UI elements related to purchasing slots. +function IsAtStableMaster() end \ No newline at end of file diff --git a/api/IsAttackAction.lua b/api/IsAttackAction.lua new file mode 100644 index 0000000..a17c291 --- /dev/null +++ b/api/IsAttackAction.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return 1nil isAttack +---Returns whether an action is the standard melee Attack action. Used in the default UI to flash the action button while auto-attack is active. Does not apply to other repeating actions such as Auto Shot (for hunters) and Shoot (for wand users); for those, see IsAutoRepeatAction. +function IsAttackAction(slot) end \ No newline at end of file diff --git a/api/IsAttackSpell.lua b/api/IsAttackSpell.lua new file mode 100644 index 0000000..77de40c --- /dev/null +++ b/api/IsAttackSpell.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param bookType spell +---@param pet +---@param spell +---@param name string +---@return 1nil isAttack +---Returns whether a spell is the standard melee Attack spell +function IsAttackSpell(index, bookType, pet, spell, name) end \ No newline at end of file diff --git a/api/IsAuctionSortReversed.lua b/api/IsAuctionSortReversed.lua new file mode 100644 index 0000000..dd0b3d3 --- /dev/null +++ b/api/IsAuctionSortReversed.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param list owner +---@param bidder +---@param list +---@param owner +---@param sort string +---@return 1nil isReversed +---@return 1nil isSorted +---Returns whether a sort criterion is applied in reverse order. No longer used in the default UI; see GetAuctionSort() instead. +function IsAuctionSortReversed(list, bidder, list, owner, sort) end \ No newline at end of file diff --git a/api/IsAutoRepeatAction.lua b/api/IsAutoRepeatAction.lua new file mode 100644 index 0000000..54f28ec --- /dev/null +++ b/api/IsAutoRepeatAction.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return 1nil isRepeating +---Returns whether an action is an automatically repeating action. Used in the default UI to flash the action button while the action is repeating. Applies to actions such as Auto Shot (for hunters) and Shoot (for wand and other ranged weapon users) but not to the standard melee Attack action; for it, see IsAttackAction. +function IsAutoRepeatAction(slot) end \ No newline at end of file diff --git a/api/IsAutoRepeatSpell.lua b/api/IsAutoRepeatSpell.lua new file mode 100644 index 0000000..177eff7 --- /dev/null +++ b/api/IsAutoRepeatSpell.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param spellName string +---@return 1nil isAutoRepeat +---Returns whether a spell is an automatically repeating spell +function IsAutoRepeatSpell(spellName) end \ No newline at end of file diff --git a/api/IsAvailableQuestTrivial.lua b/api/IsAvailableQuestTrivial.lua new file mode 100644 index 0000000..ddf5765 --- /dev/null +++ b/api/IsAvailableQuestTrivial.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return 1nil trivial +---Returns whether a quest available from the current Quest NPC is trivial at the player's level. Only returns valid information after a QUEST_GREETING event. Used in the default UI to display "(low level)" when listing the quest. Note: Most quest NPCs present available quests using the GetGossipAvailableQuests() instead of this function. +function IsAvailableQuestTrivial(index) end \ No newline at end of file diff --git a/api/IsBNLogin.lua b/api/IsBNLogin.lua new file mode 100644 index 0000000..5a38137 --- /dev/null +++ b/api/IsBNLogin.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsBNLogin() end \ No newline at end of file diff --git a/api/IsBagSlotFlagEnabledOnOtherBags.lua b/api/IsBagSlotFlagEnabledOnOtherBags.lua new file mode 100644 index 0000000..6e20f14 --- /dev/null +++ b/api/IsBagSlotFlagEnabledOnOtherBags.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsBagSlotFlagEnabledOnOtherBags() end \ No newline at end of file diff --git a/api/IsBagSlotFlagEnabledOnOtherBankBags.lua b/api/IsBagSlotFlagEnabledOnOtherBankBags.lua new file mode 100644 index 0000000..4f6298d --- /dev/null +++ b/api/IsBagSlotFlagEnabledOnOtherBankBags.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsBagSlotFlagEnabledOnOtherBankBags() end \ No newline at end of file diff --git a/api/IsBarberShopStyleValid.lua b/api/IsBarberShopStyleValid.lua new file mode 100644 index 0000000..1cbce69 --- /dev/null +++ b/api/IsBarberShopStyleValid.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsBarberShopStyleValid() end \ No newline at end of file diff --git a/api/IsBattlePayItem.lua b/api/IsBattlePayItem.lua new file mode 100644 index 0000000..aa55875 --- /dev/null +++ b/api/IsBattlePayItem.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsBattlePayItem() end \ No newline at end of file diff --git a/api/IsBlizzCon.lua b/api/IsBlizzCon.lua new file mode 100644 index 0000000..52cbe6e --- /dev/null +++ b/api/IsBlizzCon.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsBlizzCon() end \ No newline at end of file diff --git a/api/IsBreadcrumbQuest.lua b/api/IsBreadcrumbQuest.lua new file mode 100644 index 0000000..fa1272c --- /dev/null +++ b/api/IsBreadcrumbQuest.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsBreadcrumbQuest() end \ No newline at end of file diff --git a/api/IsCemeterySelectionAvailable.lua b/api/IsCemeterySelectionAvailable.lua new file mode 100644 index 0000000..076a1df --- /dev/null +++ b/api/IsCemeterySelectionAvailable.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsCemeterySelectionAvailable() end \ No newline at end of file diff --git a/api/IsCharacterNewlyBoosted.lua b/api/IsCharacterNewlyBoosted.lua new file mode 100644 index 0000000..90c3386 --- /dev/null +++ b/api/IsCharacterNewlyBoosted.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsCharacterNewlyBoosted() end \ No newline at end of file diff --git a/api/IsChatAFK.lua b/api/IsChatAFK.lua new file mode 100644 index 0000000..02008b4 --- /dev/null +++ b/api/IsChatAFK.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean isAway +---Returns whether the player's status is Away +function IsChatAFK() end \ No newline at end of file diff --git a/api/IsChatDND.lua b/api/IsChatDND.lua new file mode 100644 index 0000000..49bbe1a --- /dev/null +++ b/api/IsChatDND.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean isBusy +---Returns whether the player's status is Busy +function IsChatDND() end \ No newline at end of file diff --git a/api/IsConsumableAction.lua b/api/IsConsumableAction.lua new file mode 100644 index 0000000..a2c653c --- /dev/null +++ b/api/IsConsumableAction.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return 1nil isConsumable +---Returns whether using an action consumes an item. Applies both to consumable items (such as food and potions) and to spells which use a reagent (e.g. Prayer of Fortitude, Divine Intervention, Water Walking, Portal: Dalaran). +function IsConsumableAction(slot) end \ No newline at end of file diff --git a/api/IsConsumableItem.lua b/api/IsConsumableItem.lua new file mode 100644 index 0000000..2a19da3 --- /dev/null +++ b/api/IsConsumableItem.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemID number +---@param itemName string +---@param itemLink string +---@return 1nil consumable +---Returns whether an item is consumable. Indicates whether the item is destroyed upon use, not necessarily whether it belongs to the "Consumable" type/class. +function IsConsumableItem(itemID, itemName, itemLink) end \ No newline at end of file diff --git a/api/IsConsumableSpell.lua b/api/IsConsumableSpell.lua new file mode 100644 index 0000000..6581fd3 --- /dev/null +++ b/api/IsConsumableSpell.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param bookType spell +---@param pet +---@param spell +---@param name string +---@return 1nil isConsumable +---Returns whether casting a spell consumes a reagent item +function IsConsumableSpell(index, bookType, pet, spell, name) end \ No newline at end of file diff --git a/api/IsContainerFiltered.lua b/api/IsContainerFiltered.lua new file mode 100644 index 0000000..d965895 --- /dev/null +++ b/api/IsContainerFiltered.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsContainerFiltered() end \ No newline at end of file diff --git a/api/IsControlKeyDown.lua b/api/IsControlKeyDown.lua new file mode 100644 index 0000000..bade02f --- /dev/null +++ b/api/IsControlKeyDown.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isDown +---Returns whether a Control key on the keyboard is held down +function IsControlKeyDown() end \ No newline at end of file diff --git a/api/IsCurrentAction.lua b/api/IsCurrentAction.lua new file mode 100644 index 0000000..1f989de --- /dev/null +++ b/api/IsCurrentAction.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return 1nil isCurrent +---Returns whether an action is currently being used +function IsCurrentAction(slot) end \ No newline at end of file diff --git a/api/IsCurrentItem.lua b/api/IsCurrentItem.lua new file mode 100644 index 0000000..49ca836 --- /dev/null +++ b/api/IsCurrentItem.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemID number +---@param itemName string +---@param itemLink string +---@return 1nil isItem +---Returns whether an item is being used +function IsCurrentItem(itemID, itemName, itemLink) end \ No newline at end of file diff --git a/api/IsCurrentQuestFailed.lua b/api/IsCurrentQuestFailed.lua new file mode 100644 index 0000000..708b51e --- /dev/null +++ b/api/IsCurrentQuestFailed.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isFailed +---Returns whether the player has failed the selected quest in the quest log +function IsCurrentQuestFailed() end \ No newline at end of file diff --git a/api/IsCurrentSpell.lua b/api/IsCurrentSpell.lua new file mode 100644 index 0000000..1123dd7 --- /dev/null +++ b/api/IsCurrentSpell.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param bookType spell +---@param pet +---@param spell +---@param name string +---@return 1nil isCurrent +---Returns whether a spell is currently being used +function IsCurrentSpell(index, bookType, pet, spell, name) end \ No newline at end of file diff --git a/api/IsDebugBuild.lua b/api/IsDebugBuild.lua new file mode 100644 index 0000000..ff0c814 --- /dev/null +++ b/api/IsDebugBuild.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsDebugBuild() end \ No newline at end of file diff --git a/api/IsDesaturateSupported.lua b/api/IsDesaturateSupported.lua new file mode 100644 index 0000000..503244e --- /dev/null +++ b/api/IsDesaturateSupported.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isSupported +---Returns whether the current hardware supports desaturated textures +function IsDesaturateSupported() end \ No newline at end of file diff --git a/api/IsDisplayChannelModerator.lua b/api/IsDisplayChannelModerator.lua new file mode 100644 index 0000000..240d052 --- /dev/null +++ b/api/IsDisplayChannelModerator.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isModerator +---Returns whether the player is a moderator of the selected channel in the channel list display +function IsDisplayChannelModerator() end \ No newline at end of file diff --git a/api/IsDisplayChannelOwner.lua b/api/IsDisplayChannelOwner.lua new file mode 100644 index 0000000..3a883ae --- /dev/null +++ b/api/IsDisplayChannelOwner.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isOwner +---Returns whether the player is the owner of the selected channel in the channel list display +function IsDisplayChannelOwner() end \ No newline at end of file diff --git a/api/IsDressableItem.lua b/api/IsDressableItem.lua new file mode 100644 index 0000000..02e54ec --- /dev/null +++ b/api/IsDressableItem.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemID number +---@param itemName string +---@param itemLink string +---@return 1nil isDressable +---Returns whether an item's appearance can be previewed using the Dressing Room feature +function IsDressableItem(itemID, itemName, itemLink) end \ No newline at end of file diff --git a/api/IsEncounterInProgress.lua b/api/IsEncounterInProgress.lua new file mode 100644 index 0000000..a569944 --- /dev/null +++ b/api/IsEncounterInProgress.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsEncounterInProgress() end \ No newline at end of file diff --git a/api/IsEquippableItem.lua b/api/IsEquippableItem.lua new file mode 100644 index 0000000..e1e2fe2 --- /dev/null +++ b/api/IsEquippableItem.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemID number +---@param itemName string +---@param itemLink string +---@return 1nil isEquippable +---Returns whether an item can be equipped. Indicates whether an item is capable of being equipped on a character, not necessarily whether the player character is able to wear it. +function IsEquippableItem(itemID, itemName, itemLink) end \ No newline at end of file diff --git a/api/IsEquippedAction.lua b/api/IsEquippedAction.lua new file mode 100644 index 0000000..ee59ee6 --- /dev/null +++ b/api/IsEquippedAction.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return 1nil isEquipped +---Returns whether an action contains an equipped item. Applies to actions involving equippable items (not to consumables or other items with "Use:" effects) and indicates the effect of performing the action: if an action's item is not equipped, using the action will equip it; if the item is equipped and has a "Use:" effect, using the action will activate said effect. +function IsEquippedAction(slot) end \ No newline at end of file diff --git a/api/IsEquippedItem.lua b/api/IsEquippedItem.lua new file mode 100644 index 0000000..c2fba1c --- /dev/null +++ b/api/IsEquippedItem.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemID number +---@param itemName string +---@param itemLink string +---@return 1nil isEquipped +---Returns whether an item is currently equipped +function IsEquippedItem(itemID, itemName, itemLink) end \ No newline at end of file diff --git a/api/IsEquippedItemType.lua b/api/IsEquippedItemType.lua new file mode 100644 index 0000000..7db3c47 --- /dev/null +++ b/api/IsEquippedItemType.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param type string +---@return 1nil isEquipped +---Returns whether any items of a given type are currently equipped. Possible arguments include the localized names of item classes (as returned from GetAuctionItemClasses; e.g. "Weapon", "Armor"), subclasses (as returned from GetAuctionItemSubClasses; e.g. "One-handed axes", "Shields", "Cloth"), and the global tokens or localized names for equip locations (as returned from GetAuctionInvTypes; e.g. "INVTYPE_WEAPONMAINHAND", "Off Hand"). +function IsEquippedItemType(type) end \ No newline at end of file diff --git a/api/IsEuropeanNumbers.lua b/api/IsEuropeanNumbers.lua new file mode 100644 index 0000000..bf52d68 --- /dev/null +++ b/api/IsEuropeanNumbers.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsEuropeanNumbers() end \ No newline at end of file diff --git a/api/IsEveryoneAssistant.lua b/api/IsEveryoneAssistant.lua new file mode 100644 index 0000000..e455c75 --- /dev/null +++ b/api/IsEveryoneAssistant.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsEveryoneAssistant() end \ No newline at end of file diff --git a/api/IsExpansionTrial.lua b/api/IsExpansionTrial.lua new file mode 100644 index 0000000..affa20b --- /dev/null +++ b/api/IsExpansionTrial.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsExpansionTrial() end \ No newline at end of file diff --git a/api/IsFactionInactive.lua b/api/IsFactionInactive.lua new file mode 100644 index 0000000..0428039 --- /dev/null +++ b/api/IsFactionInactive.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return 1nil isInactive +---Returns whether a faction is flagged as "inactive". "Inactive" factions behave no differently; the distinction only exists to allow players to hide factions they don't care about from the main display. Factions thus marked are automatically moved to an "Inactive" group at the end of the faction list. +function IsFactionInactive(index) end \ No newline at end of file diff --git a/api/IsFalling.lua b/api/IsFalling.lua new file mode 100644 index 0000000..ff3048b --- /dev/null +++ b/api/IsFalling.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil falling +---Returns whether the player is currently falling +function IsFalling() end \ No newline at end of file diff --git a/api/IsFishingLoot.lua b/api/IsFishingLoot.lua new file mode 100644 index 0000000..13843d0 --- /dev/null +++ b/api/IsFishingLoot.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isFishing +---Returns whether the currently displayed loot came from fishing. Used in the default UI to play a fishing sound effect and change the appearance of the loot window. +function IsFishingLoot() end \ No newline at end of file diff --git a/api/IsFlyableArea.lua b/api/IsFlyableArea.lua new file mode 100644 index 0000000..4ac7b5d --- /dev/null +++ b/api/IsFlyableArea.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isFlyable +---Returns whether flight is allowed on the continent where the player is currently located. Returns 1 for some areas in which flight is disabled -- notably Dalaran (with the exception of the Krasus' Landing subzone) and Wintergrasp. +function IsFlyableArea() end \ No newline at end of file diff --git a/api/IsFlying.lua b/api/IsFlying.lua new file mode 100644 index 0000000..728de91 --- /dev/null +++ b/api/IsFlying.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isFlying +---Returns whether the player is currently flying +function IsFlying() end \ No newline at end of file diff --git a/api/IsGMClient.lua b/api/IsGMClient.lua new file mode 100644 index 0000000..3977344 --- /dev/null +++ b/api/IsGMClient.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsGMClient() end \ No newline at end of file diff --git a/api/IsGlyphFlagSet.lua b/api/IsGlyphFlagSet.lua new file mode 100644 index 0000000..3ac4df5 --- /dev/null +++ b/api/IsGlyphFlagSet.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsGlyphFlagSet() end \ No newline at end of file diff --git a/api/IsGuildLeader.lua b/api/IsGuildLeader.lua new file mode 100644 index 0000000..6ab3b70 --- /dev/null +++ b/api/IsGuildLeader.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isLeader +---Returns whether or player is leader of his or her guild +function IsGuildLeader() end \ No newline at end of file diff --git a/api/IsGuildRankAssignmentAllowed.lua b/api/IsGuildRankAssignmentAllowed.lua new file mode 100644 index 0000000..8f53dee --- /dev/null +++ b/api/IsGuildRankAssignmentAllowed.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsGuildRankAssignmentAllowed() end \ No newline at end of file diff --git a/api/IsHarmfulItem.lua b/api/IsHarmfulItem.lua new file mode 100644 index 0000000..410b3df --- /dev/null +++ b/api/IsHarmfulItem.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemID number +---@param itemName string +---@param itemLink string +---@return 1nil isHarmful +---Returns whether an item can be used against hostile units. Harmful items include grenades and various quest items ("Use this to zap 30 murlocs!"). +function IsHarmfulItem(itemID, itemName, itemLink) end \ No newline at end of file diff --git a/api/IsHarmfulSpell.lua b/api/IsHarmfulSpell.lua new file mode 100644 index 0000000..e198f1a --- /dev/null +++ b/api/IsHarmfulSpell.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param bookType spell +---@param pet +---@param spell +---@param name string +---@return 1nil isHarmful +---Returns whether a spell can be used against hostile units +function IsHarmfulSpell(index, bookType, pet, spell, name) end \ No newline at end of file diff --git a/api/IsHelpfulItem.lua b/api/IsHelpfulItem.lua new file mode 100644 index 0000000..b9a273a --- /dev/null +++ b/api/IsHelpfulItem.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemID number +---@param itemName string +---@param itemLink string +---@return 1nil isHarmful +---Returns whether an item can be used on the player or friendly units. Helpful items include potions, scrolls, food and drink. +function IsHelpfulItem(itemID, itemName, itemLink) end \ No newline at end of file diff --git a/api/IsHelpfulSpell.lua b/api/IsHelpfulSpell.lua new file mode 100644 index 0000000..70ec595 --- /dev/null +++ b/api/IsHelpfulSpell.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param bookType spell +---@param pet +---@param spell +---@param name string +---@return 1nil isHelpful +---Returns whether an item can be used on the player or friendly units +function IsHelpfulSpell(index, bookType, pet, spell, name) end \ No newline at end of file diff --git a/api/IsIgnored.lua b/api/IsIgnored.lua new file mode 100644 index 0000000..53d7d4a --- /dev/null +++ b/api/IsIgnored.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return 1nil isIgnored +---Returns whether a unit is on the player's ignore list +function IsIgnored(unit, name) end \ No newline at end of file diff --git a/api/IsIgnoredOrMuted.lua b/api/IsIgnoredOrMuted.lua new file mode 100644 index 0000000..c44173b --- /dev/null +++ b/api/IsIgnoredOrMuted.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return 1nil isIgnoredOrMuted +---Returns whether a unit can be heard due to ignored/muted status +function IsIgnoredOrMuted(unit) end \ No newline at end of file diff --git a/api/IsInActiveWorldPVP.lua b/api/IsInActiveWorldPVP.lua new file mode 100644 index 0000000..79d808e --- /dev/null +++ b/api/IsInActiveWorldPVP.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsInActiveWorldPVP() end \ No newline at end of file diff --git a/api/IsInArenaTeam.lua b/api/IsInArenaTeam.lua new file mode 100644 index 0000000..357eaad --- /dev/null +++ b/api/IsInArenaTeam.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean isInTeam +---Returns whether the player is on an arena team +function IsInArenaTeam() end \ No newline at end of file diff --git a/api/IsInGroup.lua b/api/IsInGroup.lua new file mode 100644 index 0000000..e9f8d2f --- /dev/null +++ b/api/IsInGroup.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param groupType LE_PARTY_CATEGORY_INSTANCE +---@param LE_PARTY_CATEGORY_HOME +---@param LE_PARTY_CATEGORY_INSTANCE +---@return boolean inGroup +---Returns whether the player is currently in the specified type of group, or any type of group if not specified. +function IsInGroup(groupType, LE_PARTY_CATEGORY_HOME, LE_PARTY_CATEGORY_INSTANCE) end \ No newline at end of file diff --git a/api/IsInGuild.lua b/api/IsInGuild.lua new file mode 100644 index 0000000..7ed3f83 --- /dev/null +++ b/api/IsInGuild.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil inGuild +---Returns whether the player is in a guild +function IsInGuild() end \ No newline at end of file diff --git a/api/IsInInstance.lua b/api/IsInInstance.lua new file mode 100644 index 0000000..262ef4f --- /dev/null +++ b/api/IsInInstance.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean isInstance +---@return raid instanceType +---@return arena +---@return none +---@return party +---@return pvp +---@return raid +---Returns whether the player is in an instance (and its type if applicable) +function IsInInstance() end \ No newline at end of file diff --git a/api/IsInLFGDungeon.lua b/api/IsInLFGDungeon.lua new file mode 100644 index 0000000..908dc6a --- /dev/null +++ b/api/IsInLFGDungeon.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsInLFGDungeon() end \ No newline at end of file diff --git a/api/IsInRaid.lua b/api/IsInRaid.lua new file mode 100644 index 0000000..ed0125d --- /dev/null +++ b/api/IsInRaid.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean inRaid +---Returns whether the player is currently in a raid group +function IsInRaid() end \ No newline at end of file diff --git a/api/IsInScenarioGroup.lua b/api/IsInScenarioGroup.lua new file mode 100644 index 0000000..8617b24 --- /dev/null +++ b/api/IsInScenarioGroup.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsInScenarioGroup() end \ No newline at end of file diff --git a/api/IsIndoors.lua b/api/IsIndoors.lua new file mode 100644 index 0000000..13fbceb --- /dev/null +++ b/api/IsIndoors.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil inside +---Returns whether the player is currently indoors +function IsIndoors() end \ No newline at end of file diff --git a/api/IsInventoryItemLocked.lua b/api/IsInventoryItemLocked.lua new file mode 100644 index 0000000..88cb9c9 --- /dev/null +++ b/api/IsInventoryItemLocked.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return 1nil isLocked +---Returns whether an inventory slot is locked. Items become locked while being moved, split, or placed into other UI elements (such as the mail, trade, and auction windows); the item is unlocked once such an action is completed. +function IsInventoryItemLocked(slot) end \ No newline at end of file diff --git a/api/IsInventoryItemProfessionBag.lua b/api/IsInventoryItemProfessionBag.lua new file mode 100644 index 0000000..4950183 --- /dev/null +++ b/api/IsInventoryItemProfessionBag.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsInventoryItemProfessionBag() end \ No newline at end of file diff --git a/api/IsItemAction.lua b/api/IsItemAction.lua new file mode 100644 index 0000000..eebe5d8 --- /dev/null +++ b/api/IsItemAction.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsItemAction() end \ No newline at end of file diff --git a/api/IsItemInRange.lua b/api/IsItemInRange.lua new file mode 100644 index 0000000..c1b73cf --- /dev/null +++ b/api/IsItemInRange.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemID number +---@param itemName string +---@param itemLink string +---@param unit string +---@return 1nil inRange +---Returns whether the player is in range to use an item on a unit +function IsItemInRange(itemID, itemName, itemLink, unit) end \ No newline at end of file diff --git a/api/IsLFGComplete.lua b/api/IsLFGComplete.lua new file mode 100644 index 0000000..b8cd062 --- /dev/null +++ b/api/IsLFGComplete.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsLFGComplete() end \ No newline at end of file diff --git a/api/IsLFGDungeonJoinable.lua b/api/IsLFGDungeonJoinable.lua new file mode 100644 index 0000000..a2b3f0e --- /dev/null +++ b/api/IsLFGDungeonJoinable.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsLFGDungeonJoinable() end \ No newline at end of file diff --git a/api/IsLeftAltKeyDown.lua b/api/IsLeftAltKeyDown.lua new file mode 100644 index 0000000..233d8b1 --- /dev/null +++ b/api/IsLeftAltKeyDown.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isDown +---Returns whether the left Alt key is currently held down. (Note: The Mac WoW client does not distingish between left and right modifier keys, so both Alt keys are reported as Left Alt.) +function IsLeftAltKeyDown() end \ No newline at end of file diff --git a/api/IsLeftControlKeyDown.lua b/api/IsLeftControlKeyDown.lua new file mode 100644 index 0000000..7367ff7 --- /dev/null +++ b/api/IsLeftControlKeyDown.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isDown +---Returns whether the left Control key is held down. (Note: The Mac WoW client does not distingish between left and right modifier keys, so both Control keys are reported as Left Control.) +function IsLeftControlKeyDown() end \ No newline at end of file diff --git a/api/IsLeftShiftKeyDown.lua b/api/IsLeftShiftKeyDown.lua new file mode 100644 index 0000000..f6ea512 --- /dev/null +++ b/api/IsLeftShiftKeyDown.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isDown +---Returns whether the left Shift key on the keyboard is held down. (Note: The Mac WoW client does not distingish between left and right modifier keys, so both Shift keys are reported as Left Shift.) +function IsLeftShiftKeyDown() end \ No newline at end of file diff --git a/api/IsLegacyDifficulty.lua b/api/IsLegacyDifficulty.lua new file mode 100644 index 0000000..6135ddd --- /dev/null +++ b/api/IsLegacyDifficulty.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsLegacyDifficulty() end \ No newline at end of file diff --git a/api/IsLinuxClient.lua b/api/IsLinuxClient.lua new file mode 100644 index 0000000..93f5f00 --- /dev/null +++ b/api/IsLinuxClient.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return nil isLinux +---Returns whether the player is using the native Linux game client. This function does NOT return true if the player is running a Windows client under Wine or other virtualization software. No native Linux client has been made public at this time. +function IsLinuxClient() end \ No newline at end of file diff --git a/api/IsLoggedIn.lua b/api/IsLoggedIn.lua new file mode 100644 index 0000000..2f72ed0 --- /dev/null +++ b/api/IsLoggedIn.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil loggedIn +---Returns whether the login process has completed. The PLAYER_LOGIN event provides similar information; this function presents an alternative that can be used across UI reloads. +function IsLoggedIn() end \ No newline at end of file diff --git a/api/IsMacClient.lua b/api/IsMacClient.lua new file mode 100644 index 0000000..ce42802 --- /dev/null +++ b/api/IsMacClient.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isMac +---Returns whether the player is using the Mac OS X game client +function IsMacClient() end \ No newline at end of file diff --git a/api/IsMapGarrisonMap.lua b/api/IsMapGarrisonMap.lua new file mode 100644 index 0000000..b786380 --- /dev/null +++ b/api/IsMapGarrisonMap.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsMapGarrisonMap() end \ No newline at end of file diff --git a/api/IsMasterLooter.lua b/api/IsMasterLooter.lua new file mode 100644 index 0000000..7148938 --- /dev/null +++ b/api/IsMasterLooter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsMasterLooter() end \ No newline at end of file diff --git a/api/IsModifiedClick.lua b/api/IsModifiedClick.lua new file mode 100644 index 0000000..170b1aa --- /dev/null +++ b/api/IsModifiedClick.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param type string +---@return 1nil modifiedClick +---Determines if the modifiers specified in the click-type had been held down while the button click occurred.. If called from a click handler (OnMouseDown, OnMouseUp, OnClick, OnDoubleClick, PreClick, or PostClick), checks mouse buttons included in the binding; otherwise checks modifiers only (see example). +function IsModifiedClick(type) end \ No newline at end of file diff --git a/api/IsModifierKeyDown.lua b/api/IsModifierKeyDown.lua new file mode 100644 index 0000000..94ff7d6 --- /dev/null +++ b/api/IsModifierKeyDown.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isDown +---Returns whether a modifier key is held down. Modifier keys include shift, control or alt on either side of the keyboard. WoW does not recognize platform-specific modifier keys (such as fn, meta, Windows, or Command). +function IsModifierKeyDown() end \ No newline at end of file diff --git a/api/IsMounted.lua b/api/IsMounted.lua new file mode 100644 index 0000000..0ea32f3 --- /dev/null +++ b/api/IsMounted.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil mounted +---Returns whether the player is mounted +function IsMounted() end \ No newline at end of file diff --git a/api/IsMouseButtonDown.lua b/api/IsMouseButtonDown.lua new file mode 100644 index 0000000..f63f2ec --- /dev/null +++ b/api/IsMouseButtonDown.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param button 5 or Button5 +---@param 1 or LeftButton +---@param 2 or RightButton +---@param 3 or MiddleButton +---@param 4 or Button4 +---@param 5 or Button5 +---@return 1nil isDown +---Returns whether a given mouse button is held down. If no button is specified, returns 1 if any mouse button is held down. +function IsMouseButtonDown(button, 1 or LeftButton, 2 or RightButton, 3 or MiddleButton, 4 or Button4, 5 or Button5) end \ No newline at end of file diff --git a/api/IsMouselooking.lua b/api/IsMouselooking.lua new file mode 100644 index 0000000..72d54b6 --- /dev/null +++ b/api/IsMouselooking.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean isLooking +---Returns whether mouselook mode is active +function IsMouselooking() end \ No newline at end of file diff --git a/api/IsMovieLocal.lua b/api/IsMovieLocal.lua new file mode 100644 index 0000000..4b821ad --- /dev/null +++ b/api/IsMovieLocal.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsMovieLocal() end \ No newline at end of file diff --git a/api/IsMoviePlayable.lua b/api/IsMoviePlayable.lua new file mode 100644 index 0000000..b3221be --- /dev/null +++ b/api/IsMoviePlayable.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsMoviePlayable() end \ No newline at end of file diff --git a/api/IsMuted.lua b/api/IsMuted.lua new file mode 100644 index 0000000..74e3bf0 --- /dev/null +++ b/api/IsMuted.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return 1nil muted +---Returns whether a character has been muted by the player +function IsMuted(unit, name) end \ No newline at end of file diff --git a/api/IsOnGlueScreen.lua b/api/IsOnGlueScreen.lua new file mode 100644 index 0000000..41f5eae --- /dev/null +++ b/api/IsOnGlueScreen.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsOnGlueScreen() end \ No newline at end of file diff --git a/api/IsOnTournamentRealm.lua b/api/IsOnTournamentRealm.lua new file mode 100644 index 0000000..6a9423e --- /dev/null +++ b/api/IsOnTournamentRealm.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Returns whether the player is on an Arena Tournament realm +function IsOnTournamentRealm() end \ No newline at end of file diff --git a/api/IsOutOfBounds.lua b/api/IsOutOfBounds.lua new file mode 100644 index 0000000..3ea0d50 --- /dev/null +++ b/api/IsOutOfBounds.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil outOfBounds +---Returns whether the player is currently outside the bounds of the world. Used in the default UI (in conjunction with IsFalling()) to allow the player to release to a graveyard if the character has encountered a bug and fallen underneath the world geometry. +function IsOutOfBounds() end \ No newline at end of file diff --git a/api/IsOutdoors.lua b/api/IsOutdoors.lua new file mode 100644 index 0000000..4ac0515 --- /dev/null +++ b/api/IsOutdoors.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isOutdoors +---Returns whether the player is currently outdoors. "Outdoors" as defined by this function corresponds to the ability to use a mount in that specific location, not necessarily whether there is a roof above the player character's head. For example, returns 1 in Ironforge, Undercity, and the Caverns of Time, but nil in the nominally outdoor areas of instances such as Stratholme, Drak'tharon Keep, and Hellfire Ramparts. (Note that even in "outdoor" areas, standing on top of certain objects may interfere with the player's ability to mount up.) +function IsOutdoors() end \ No newline at end of file diff --git a/api/IsPVPTimerRunning.lua b/api/IsPVPTimerRunning.lua new file mode 100644 index 0000000..0dd6db5 --- /dev/null +++ b/api/IsPVPTimerRunning.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isRunning +---Returns whether the player's PvP flag will expire after a period of time. If in a zone that flags the player for PvP, or if the player has manually enabled PvP, the flag will not expire. Once not in such a zone, or once the player has manually disabled PvP, or if the player has been flagged by attacking an enemy unit, the timer starts running and the player's PvP flag will expire after some time. +function IsPVPTimerRunning() end \ No newline at end of file diff --git a/api/IsPartyLFG.lua b/api/IsPartyLFG.lua new file mode 100644 index 0000000..bb28e68 --- /dev/null +++ b/api/IsPartyLFG.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsPartyLFG() end \ No newline at end of file diff --git a/api/IsPassiveSpell.lua b/api/IsPassiveSpell.lua new file mode 100644 index 0000000..91b9e72 --- /dev/null +++ b/api/IsPassiveSpell.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param bookType spell +---@param pet +---@param spell +---@param name string +---@return 1nil isPassive +---Returns whether a spell is passive (cannot be cast) +function IsPassiveSpell(index, bookType, pet, spell, name) end \ No newline at end of file diff --git a/api/IsPetActive.lua b/api/IsPetActive.lua new file mode 100644 index 0000000..da81417 --- /dev/null +++ b/api/IsPetActive.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsPetActive() end \ No newline at end of file diff --git a/api/IsPetAttackAction.lua b/api/IsPetAttackAction.lua new file mode 100644 index 0000000..b24a4ef --- /dev/null +++ b/api/IsPetAttackAction.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return boolean isAttack +---Returns if the pet action button is the pet attack command +function IsPetAttackAction(index) end \ No newline at end of file diff --git a/api/IsPetAttackActive.lua b/api/IsPetAttackActive.lua new file mode 100644 index 0000000..385d17b --- /dev/null +++ b/api/IsPetAttackActive.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isActive +---Returns whether the pet's attack action is currently active +function IsPetAttackActive() end \ No newline at end of file diff --git a/api/IsPlayerInMicroDungeon.lua b/api/IsPlayerInMicroDungeon.lua new file mode 100644 index 0000000..7940c96 --- /dev/null +++ b/api/IsPlayerInMicroDungeon.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsPlayerInMicroDungeon() end \ No newline at end of file diff --git a/api/IsPlayerInWorld.lua b/api/IsPlayerInWorld.lua new file mode 100644 index 0000000..8eb86d3 --- /dev/null +++ b/api/IsPlayerInWorld.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsPlayerInWorld() end \ No newline at end of file diff --git a/api/IsPlayerMoving.lua b/api/IsPlayerMoving.lua new file mode 100644 index 0000000..8423ce9 --- /dev/null +++ b/api/IsPlayerMoving.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsPlayerMoving() end \ No newline at end of file diff --git a/api/IsPlayerNeutral.lua b/api/IsPlayerNeutral.lua new file mode 100644 index 0000000..4b625f9 --- /dev/null +++ b/api/IsPlayerNeutral.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsPlayerNeutral() end \ No newline at end of file diff --git a/api/IsPlayerSpell.lua b/api/IsPlayerSpell.lua new file mode 100644 index 0000000..9a0ce35 --- /dev/null +++ b/api/IsPlayerSpell.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param spellID number +---@return boolean isPlayerSpell +---Returns true if the spell is available to the player's current specialization and talents. This does not check any immediate circumstances that would prevent the casting action itself; only that the spell is available within the constraints of active specialization/talent choices. Used by BlizzardUI to determine the drawing of several class-specific power indicators such as Eclipse and Burning Embers. +function IsPlayerSpell(spellID) end \ No newline at end of file diff --git a/api/IsPossessBarVisible.lua b/api/IsPossessBarVisible.lua new file mode 100644 index 0000000..c5bc9f9 --- /dev/null +++ b/api/IsPossessBarVisible.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isVisible +---Returns whether a special action bar should be shown while the player possesses another unit. Used in the default UI to switch between using the ShapeshiftBarFrame or PossessBarFrame to show actions belonging to the possessed unit. +function IsPossessBarVisible() end \ No newline at end of file diff --git a/api/IsQuestCompletable.lua b/api/IsQuestCompletable.lua new file mode 100644 index 0000000..edaa0a6 --- /dev/null +++ b/api/IsQuestCompletable.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isCompletable +---Returns whether the player can complete the quest presented by a questgiver +function IsQuestCompletable() end \ No newline at end of file diff --git a/api/IsQuestComplete.lua b/api/IsQuestComplete.lua new file mode 100644 index 0000000..6ab1994 --- /dev/null +++ b/api/IsQuestComplete.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsQuestComplete() end \ No newline at end of file diff --git a/api/IsQuestFlaggedCompleted.lua b/api/IsQuestFlaggedCompleted.lua new file mode 100644 index 0000000..e3541f6 --- /dev/null +++ b/api/IsQuestFlaggedCompleted.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param questID number +---@return 1nil isCompleted +---Returns whether a quest is completed by the player or not +function IsQuestFlaggedCompleted(questID) end \ No newline at end of file diff --git a/api/IsQuestHardWatched.lua b/api/IsQuestHardWatched.lua new file mode 100644 index 0000000..4bb65c5 --- /dev/null +++ b/api/IsQuestHardWatched.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsQuestHardWatched() end \ No newline at end of file diff --git a/api/IsQuestLogSpecialItemInRange.lua b/api/IsQuestLogSpecialItemInRange.lua new file mode 100644 index 0000000..ef98e6f --- /dev/null +++ b/api/IsQuestLogSpecialItemInRange.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param questIndex number +---@return number inRange +---Returns whether the player's target is in range for using an item associated with a current quest. Available for a number of quests which involve using an item (i.e. "Use the MacGuffin to summon and defeat the boss", "Use this saw to fell 12 trees", etc.) +function IsQuestLogSpecialItemInRange(questIndex) end \ No newline at end of file diff --git a/api/IsQuestSequenced.lua b/api/IsQuestSequenced.lua new file mode 100644 index 0000000..0c16f36 --- /dev/null +++ b/api/IsQuestSequenced.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsQuestSequenced() end \ No newline at end of file diff --git a/api/IsQuestTask.lua b/api/IsQuestTask.lua new file mode 100644 index 0000000..4b10fdd --- /dev/null +++ b/api/IsQuestTask.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsQuestTask() end \ No newline at end of file diff --git a/api/IsQuestWatched.lua b/api/IsQuestWatched.lua new file mode 100644 index 0000000..0e05288 --- /dev/null +++ b/api/IsQuestWatched.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param questIndex number +---@return 1nil isWatched +---Returns whether a quest from the quest log is listed in the objectives tracker +function IsQuestWatched(questIndex) end \ No newline at end of file diff --git a/api/IsRaidMarkerActive.lua b/api/IsRaidMarkerActive.lua new file mode 100644 index 0000000..a172a11 --- /dev/null +++ b/api/IsRaidMarkerActive.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsRaidMarkerActive() end \ No newline at end of file diff --git a/api/IsRatedBattleground.lua b/api/IsRatedBattleground.lua new file mode 100644 index 0000000..8e39e88 --- /dev/null +++ b/api/IsRatedBattleground.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean isRated +---Returns whether or not the player is in a rated battleground +function IsRatedBattleground() end \ No newline at end of file diff --git a/api/IsRatedMap.lua b/api/IsRatedMap.lua new file mode 100644 index 0000000..c66bf0a --- /dev/null +++ b/api/IsRatedMap.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsRatedMap() end \ No newline at end of file diff --git a/api/IsReagentBankUnlocked.lua b/api/IsReagentBankUnlocked.lua new file mode 100644 index 0000000..eb8bf8c --- /dev/null +++ b/api/IsReagentBankUnlocked.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean isBankUnlocked +---Returns true if Ragent Bank has been purchased +function IsReagentBankUnlocked() end \ No newline at end of file diff --git a/api/IsReferAFriendLinked.lua b/api/IsReferAFriendLinked.lua new file mode 100644 index 0000000..de590d5 --- /dev/null +++ b/api/IsReferAFriendLinked.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return 1nil isLinked +---Returns whether a unit's account is linked to the player's via the Recruit-a-Friend program +function IsReferAFriendLinked(unit) end \ No newline at end of file diff --git a/api/IsResting.lua b/api/IsResting.lua new file mode 100644 index 0000000..9bd1b9d --- /dev/null +++ b/api/IsResting.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean resting +---Returns whether the player is currently resting. Rest state is provided in Inns and major cities and allows the player to log out immediately (instead of after a brief delay) and accrue bonus XP to be awarded for kills. +function IsResting() end \ No newline at end of file diff --git a/api/IsRestrictedAccount.lua b/api/IsRestrictedAccount.lua new file mode 100644 index 0000000..eaae1a6 --- /dev/null +++ b/api/IsRestrictedAccount.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsRestrictedAccount() end \ No newline at end of file diff --git a/api/IsRightAltKeyDown.lua b/api/IsRightAltKeyDown.lua new file mode 100644 index 0000000..ab53c75 --- /dev/null +++ b/api/IsRightAltKeyDown.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isDown +---Returns whether the right Alt key is currently held down. (Note: The Mac WoW client does not distingish between left and right modifier keys, so both Alt keys are reported as Left Alt.) +function IsRightAltKeyDown() end \ No newline at end of file diff --git a/api/IsRightControlKeyDown.lua b/api/IsRightControlKeyDown.lua new file mode 100644 index 0000000..1e3fb9f --- /dev/null +++ b/api/IsRightControlKeyDown.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isDown +---Returns whether the right Control key on the keyboard is held down. (Note: The Mac WoW client does not distingish between left and right modifier keys, so both Control keys are reported as Left Control.) +function IsRightControlKeyDown() end \ No newline at end of file diff --git a/api/IsRightShiftKeyDown.lua b/api/IsRightShiftKeyDown.lua new file mode 100644 index 0000000..d3edfbb --- /dev/null +++ b/api/IsRightShiftKeyDown.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isDown +---Returns whether the right shift key on the keyboard is held down. (Note: The Mac WoW client does not distingish between left and right modifier keys, so both Shift keys are reported as Left Shift.) +function IsRightShiftKeyDown() end \ No newline at end of file diff --git a/api/IsSelectedSpellBookItem.lua b/api/IsSelectedSpellBookItem.lua new file mode 100644 index 0000000..540e290 --- /dev/null +++ b/api/IsSelectedSpellBookItem.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsSelectedSpellBookItem() end \ No newline at end of file diff --git a/api/IsShiftKeyDown.lua b/api/IsShiftKeyDown.lua new file mode 100644 index 0000000..c373259 --- /dev/null +++ b/api/IsShiftKeyDown.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isDown +---Returns whether a Shift key on the keyboard is held down +function IsShiftKeyDown() end \ No newline at end of file diff --git a/api/IsSilenced.lua b/api/IsSilenced.lua new file mode 100644 index 0000000..51498bf --- /dev/null +++ b/api/IsSilenced.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param channel string +---@return 1nil isSilenced +---Returns whether a character is silenced on a chat channel +function IsSilenced(name, channel) end \ No newline at end of file diff --git a/api/IsSpellClassOrSpec.lua b/api/IsSpellClassOrSpec.lua new file mode 100644 index 0000000..2ac6d58 --- /dev/null +++ b/api/IsSpellClassOrSpec.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsSpellClassOrSpec() end \ No newline at end of file diff --git a/api/IsSpellInRange.lua b/api/IsSpellInRange.lua new file mode 100644 index 0000000..dc9866f --- /dev/null +++ b/api/IsSpellInRange.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param bookType spell +---@param pet +---@param spell +---@param name string +---@param unit string +---@return 1nil inRange +---Returns whether the player is in range to cast a spell on a unit +function IsSpellInRange(index, bookType, pet, spell, name, unit) end \ No newline at end of file diff --git a/api/IsSpellKnown.lua b/api/IsSpellKnown.lua new file mode 100644 index 0000000..2626ce9 --- /dev/null +++ b/api/IsSpellKnown.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param spellID number +---@param isPet boolean +---@return boolean isKnown +---Returns whether the player (or pet) knows a spell +function IsSpellKnown(spellID, isPet) end \ No newline at end of file diff --git a/api/IsSpellOverlayed.lua b/api/IsSpellOverlayed.lua new file mode 100644 index 0000000..c3d3c86 --- /dev/null +++ b/api/IsSpellOverlayed.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param spellID integer +---@return boolean state +---Checks if a given spell ID has an active spell overlay. This function continues to return expected results even if the user has spell overlays disabled, and is used internally to check if an action button should display a glow. This function does not work with macro ID's. +function IsSpellOverlayed(spellID) end \ No newline at end of file diff --git a/api/IsStackableAction.lua b/api/IsStackableAction.lua new file mode 100644 index 0000000..504a5b3 --- /dev/null +++ b/api/IsStackableAction.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return 1nil isStackable +---Returns whether an action uses stackable items. Applies to consumable items such as potions, wizard oils, food and drink; not used for spells which consume reagents (for those, see IsConsumableAction). +function IsStackableAction(slot) end \ No newline at end of file diff --git a/api/IsStealthed.lua b/api/IsStealthed.lua new file mode 100644 index 0000000..f9a61bc --- /dev/null +++ b/api/IsStealthed.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil stealthed +---Returns whether the player is currently stealthed +function IsStealthed() end \ No newline at end of file diff --git a/api/IsStereoVideoAvailable.lua b/api/IsStereoVideoAvailable.lua new file mode 100644 index 0000000..4a4ce2b --- /dev/null +++ b/api/IsStereoVideoAvailable.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isAvailable +---Returns whether the current system supports stereoscopic 3D display +function IsStereoVideoAvailable() end \ No newline at end of file diff --git a/api/IsStoryQuest.lua b/api/IsStoryQuest.lua new file mode 100644 index 0000000..edbbd57 --- /dev/null +++ b/api/IsStoryQuest.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsStoryQuest() end \ No newline at end of file diff --git a/api/IsSubZonePVPPOI.lua b/api/IsSubZonePVPPOI.lua new file mode 100644 index 0000000..fa7fb12 --- /dev/null +++ b/api/IsSubZonePVPPOI.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isPVPPOI +---Returns whether the current area has PvP (or other) objectives to be displayed. Used in the default UI when the "Display World PVP Objectives\ setting is set to \Dynamic\, in which case objective information is only shown when the player is near an objective. Examples include the towers in Eastern Plaguelands and Hellfire Peninsula as well as non-PvP objectives such as in the Old Hillsbrad instance, the Death Knight starter quests, and the Battle for Undercity quest event. +function IsSubZonePVPPOI() end \ No newline at end of file diff --git a/api/IsSwimming.lua b/api/IsSwimming.lua new file mode 100644 index 0000000..0713333 --- /dev/null +++ b/api/IsSwimming.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isSwimming +---Returns whether the player is currently swimming. "Swimming" as defined by this function corresponds to the ability to use swimming abilities (such as druid Aquatic Form) or inability to use land-restricted abilities (such as eating or summoning a flying mount), not necessarily to whether the player is in water. +function IsSwimming() end \ No newline at end of file diff --git a/api/IsTalentSpell.lua b/api/IsTalentSpell.lua new file mode 100644 index 0000000..76567a1 --- /dev/null +++ b/api/IsTalentSpell.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param bookType spell +---@param pet +---@param spell +---@return boolean isTalentSpell +---Returns true if the given spellbook item was added by an active talent. Used once in the BlizzardUI to determine whether an item in the player's active spellbook should have "Talent" in their subtext. This will not work with inactive spellbook items as their talents aren't currently selected. +function IsTalentSpell(index, bookType, pet, spell) end \ No newline at end of file diff --git a/api/IsTestBuild.lua b/api/IsTestBuild.lua new file mode 100644 index 0000000..d0d9233 --- /dev/null +++ b/api/IsTestBuild.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsTestBuild() end \ No newline at end of file diff --git a/api/IsThreatWarningEnabled.lua b/api/IsThreatWarningEnabled.lua new file mode 100644 index 0000000..7cf3e68 --- /dev/null +++ b/api/IsThreatWarningEnabled.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil enabled +---Returns whether the default Aggro Warning UI should currently be shown. This function (and the threatWarning CVar that affects its behavior) has no effect on other threat APIs; it merely indicates whether Blizzard's threat warning UI should be displayed. +function IsThreatWarningEnabled() end \ No newline at end of file diff --git a/api/IsTitleKnown.lua b/api/IsTitleKnown.lua new file mode 100644 index 0000000..ea3a883 --- /dev/null +++ b/api/IsTitleKnown.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param titleIndex integer +---@return number isKnown +---Returns whether the player has earned the ability to display a title +function IsTitleKnown(titleIndex) end \ No newline at end of file diff --git a/api/IsTrackedAchievement.lua b/api/IsTrackedAchievement.lua new file mode 100644 index 0000000..3d513b2 --- /dev/null +++ b/api/IsTrackedAchievement.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@return boolean isTracked +---Returns whether an achievement is flagged for display in the objectives tracker UI +function IsTrackedAchievement(id) end \ No newline at end of file diff --git a/api/IsTrackingBattlePets.lua b/api/IsTrackingBattlePets.lua new file mode 100644 index 0000000..832f190 --- /dev/null +++ b/api/IsTrackingBattlePets.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsTrackingBattlePets() end \ No newline at end of file diff --git a/api/IsTradeSkillGuild.lua b/api/IsTradeSkillGuild.lua new file mode 100644 index 0000000..7c6dd5c --- /dev/null +++ b/api/IsTradeSkillGuild.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsTradeSkillGuild() end \ No newline at end of file diff --git a/api/IsTradeSkillLinked.lua b/api/IsTradeSkillLinked.lua new file mode 100644 index 0000000..7c995ad --- /dev/null +++ b/api/IsTradeSkillLinked.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isLinked +---@return string name +---Returns whether the TradeSkill UI is showing another player's skill +function IsTradeSkillLinked() end \ No newline at end of file diff --git a/api/IsTradeSkillReady.lua b/api/IsTradeSkillReady.lua new file mode 100644 index 0000000..e51e910 --- /dev/null +++ b/api/IsTradeSkillReady.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsTradeSkillReady() end \ No newline at end of file diff --git a/api/IsTradeSkillRepeating.lua b/api/IsTradeSkillRepeating.lua new file mode 100644 index 0000000..77a35eb --- /dev/null +++ b/api/IsTradeSkillRepeating.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsTradeSkillRepeating() end \ No newline at end of file diff --git a/api/IsTradeskillTrainer.lua b/api/IsTradeskillTrainer.lua new file mode 100644 index 0000000..c909570 --- /dev/null +++ b/api/IsTradeskillTrainer.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isTradeskill +---Returns whether the player is interacting with a trade skill trainer (as opposed to a class trainer) +function IsTradeskillTrainer() end \ No newline at end of file diff --git a/api/IsTrialAccount.lua b/api/IsTrialAccount.lua new file mode 100644 index 0000000..03a99f1 --- /dev/null +++ b/api/IsTrialAccount.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsTrialAccount() end \ No newline at end of file diff --git a/api/IsTutorialFlagged.lua b/api/IsTutorialFlagged.lua new file mode 100644 index 0000000..17e6e3c --- /dev/null +++ b/api/IsTutorialFlagged.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsTutorialFlagged() end \ No newline at end of file diff --git a/api/IsUnitOnQuest.lua b/api/IsUnitOnQuest.lua new file mode 100644 index 0000000..bd460cd --- /dev/null +++ b/api/IsUnitOnQuest.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param unit string +---@param name string +---@return 1nil state +---Returns whether a unit is on one of the quests in the player's quest log +function IsUnitOnQuest(index, unit, name) end \ No newline at end of file diff --git a/api/IsUnitOnQuestByQuestID.lua b/api/IsUnitOnQuestByQuestID.lua new file mode 100644 index 0000000..13c5792 --- /dev/null +++ b/api/IsUnitOnQuestByQuestID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsUnitOnQuestByQuestID() end \ No newline at end of file diff --git a/api/IsUsableAction.lua b/api/IsUsableAction.lua new file mode 100644 index 0000000..a3a04c8 --- /dev/null +++ b/api/IsUsableAction.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@return 1nil isUsable +---@return 1nil notEnoughMana +---Returns whether an action is usable +function IsUsableAction(slot) end \ No newline at end of file diff --git a/api/IsUsableItem.lua b/api/IsUsableItem.lua new file mode 100644 index 0000000..803b054 --- /dev/null +++ b/api/IsUsableItem.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemID number +---@param itemName string +---@param itemLink string +---@return 1nil isUsable +---@return 1nil notEnoughMana +---Returns whether an item can currently be used. Does not account for item cooldowns (see GetItemCooldown() -- returns 1 if other conditions allow for using the item (e.g. if the item can only be used while outdoors). +function IsUsableItem(itemID, itemName, itemLink) end \ No newline at end of file diff --git a/api/IsUsableSpell.lua b/api/IsUsableSpell.lua new file mode 100644 index 0000000..f693d87 --- /dev/null +++ b/api/IsUsableSpell.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param bookType spell +---@param pet +---@param spell +---@param name string +---@return 1nil isUsable +---@return 1nil notEnoughMana +---Returns whether or not a given spell is usable or cannot be used due to lack of mana. Does not account for spell cooldowns (see GetSpellCooldown() -- returns 1 if other conditions allow for casting the spell (e.g. if the spell can only be cast while outdoors). +function IsUsableSpell(index, bookType, pet, spell, name) end \ No newline at end of file diff --git a/api/IsUsingVehicleControls.lua b/api/IsUsingVehicleControls.lua new file mode 100644 index 0000000..aadf061 --- /dev/null +++ b/api/IsUsingVehicleControls.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsUsingVehicleControls() end \ No newline at end of file diff --git a/api/IsVehicleAimAngleAdjustable.lua b/api/IsVehicleAimAngleAdjustable.lua new file mode 100644 index 0000000..98a6a94 --- /dev/null +++ b/api/IsVehicleAimAngleAdjustable.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil hasAngleControl +---Returns whether the player is controlling a vehicle weapon with adjustable aim angle +function IsVehicleAimAngleAdjustable() end \ No newline at end of file diff --git a/api/IsVehicleAimPowerAdjustable.lua b/api/IsVehicleAimPowerAdjustable.lua new file mode 100644 index 0000000..c3af1cc --- /dev/null +++ b/api/IsVehicleAimPowerAdjustable.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsVehicleAimPowerAdjustable() end \ No newline at end of file diff --git a/api/IsVoiceChatAllowed.lua b/api/IsVoiceChatAllowed.lua new file mode 100644 index 0000000..aa7a40a --- /dev/null +++ b/api/IsVoiceChatAllowed.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isAllowed +---Returns whether the player is allowed to enable the voice chat feature +function IsVoiceChatAllowed() end \ No newline at end of file diff --git a/api/IsVoiceChatAllowedByServer.lua b/api/IsVoiceChatAllowedByServer.lua new file mode 100644 index 0000000..165d344 --- /dev/null +++ b/api/IsVoiceChatAllowedByServer.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Returns whether voice chat is supported by the realm server +function IsVoiceChatAllowedByServer() end \ No newline at end of file diff --git a/api/IsVoiceChatEnabled.lua b/api/IsVoiceChatEnabled.lua new file mode 100644 index 0000000..43b3cd1 --- /dev/null +++ b/api/IsVoiceChatEnabled.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isEnabled +---Returns whether the voice chat system is enabled +function IsVoiceChatEnabled() end \ No newline at end of file diff --git a/api/IsVoidStorageReady.lua b/api/IsVoidStorageReady.lua new file mode 100644 index 0000000..ddb9f6c --- /dev/null +++ b/api/IsVoidStorageReady.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean isReady +---Returns whether the void storage content can be accessed. This will return true after the first visit of the void storage in the current session. Reloading the ui will not reset this, only a complete log out of the char will. +function IsVoidStorageReady() end \ No newline at end of file diff --git a/api/IsWargame.lua b/api/IsWargame.lua new file mode 100644 index 0000000..fd012eb --- /dev/null +++ b/api/IsWargame.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function IsWargame() end \ No newline at end of file diff --git a/api/IsWindowsClient.lua b/api/IsWindowsClient.lua new file mode 100644 index 0000000..5a6dda9 --- /dev/null +++ b/api/IsWindowsClient.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isWindows +---Returns whether the player is using the Windows game client +function IsWindowsClient() end \ No newline at end of file diff --git a/api/IsXPUserDisabled.lua b/api/IsXPUserDisabled.lua new file mode 100644 index 0000000..662b09c --- /dev/null +++ b/api/IsXPUserDisabled.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean isDisabled +---Returns whether experience gain has been disabled for the player +function IsXPUserDisabled() end \ No newline at end of file diff --git a/api/ItemAddedToArtifact.lua b/api/ItemAddedToArtifact.lua new file mode 100644 index 0000000..1718d2f --- /dev/null +++ b/api/ItemAddedToArtifact.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ItemAddedToArtifact() end \ No newline at end of file diff --git a/api/ItemHasRange.lua b/api/ItemHasRange.lua new file mode 100644 index 0000000..354f058 --- /dev/null +++ b/api/ItemHasRange.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemID number +---@param itemName string +---@param itemLink string +---@return 1nil hasRange +---Returns whether an item has a range limitation for its use. For example, Mistletoe can only be used on another character within a given range of the player, but a Hearthstone has no target and thus no range restriction. Returns nil for items which have a range restriction but are area-targeted and not unit-targeted (e.g. grenades). +function ItemHasRange(itemID, itemName, itemLink) end \ No newline at end of file diff --git a/api/ItemTextGetCreator.lua b/api/ItemTextGetCreator.lua new file mode 100644 index 0000000..ad18df1 --- /dev/null +++ b/api/ItemTextGetCreator.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string creator +---Returns the original author of the currently viewed text item. Used for mail messages sent by other players; when the player makes a permanent copy of a letter and reads it from inventory, the default UI uses this function to display a signature (e.g. "From, Leeroy") at the end of the message text. +function ItemTextGetCreator() end \ No newline at end of file diff --git a/api/ItemTextGetItem.lua b/api/ItemTextGetItem.lua new file mode 100644 index 0000000..58d5ab0 --- /dev/null +++ b/api/ItemTextGetItem.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string text +---Returns the name of the currently viewed text item. Used for readable world objects (plaques, books on tables, etc) and readable inventory items (looted books/parchments/scrolls/etc, saved copies of mail messages). For saved mail messages the name returned is always "Plain Letter" (or localized equivalent); the message subject is lost when saving a copy. +function ItemTextGetItem() end \ No newline at end of file diff --git a/api/ItemTextGetMaterial.lua b/api/ItemTextGetMaterial.lua new file mode 100644 index 0000000..5feef8d --- /dev/null +++ b/api/ItemTextGetMaterial.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return Stone material +---@return Bronze +---@return Marble +---@return Parchment +---@return Silver +---@return Stone +---Returns display style information for the currently viewed text item. The value returned can be used to look up background textures and text colors for display: Background textures displayed in the default UI can be found by prepending "Interface\\ItemTextFrame\\ItemText-" and appending "-TopLeft", "-TopRight", "-BotLeft", "-BotRight" to the material string (e.g. "Interface\\ItemTextFrame\\ItemText-Stone-TopLeft"). Colors for body and title text can be found by calling GetMaterialTextColors(material) (a Lua function implemented in the Blizzard UI). In cases where this function returns nil, the default UI uses the colors and textures for "Parchment". +function ItemTextGetMaterial() end \ No newline at end of file diff --git a/api/ItemTextGetPage.lua b/api/ItemTextGetPage.lua new file mode 100644 index 0000000..ec41fc0 --- /dev/null +++ b/api/ItemTextGetPage.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number page +---Returns the current page number in the currently viewed text item +function ItemTextGetPage() end \ No newline at end of file diff --git a/api/ItemTextGetText.lua b/api/ItemTextGetText.lua new file mode 100644 index 0000000..c2fad75 --- /dev/null +++ b/api/ItemTextGetText.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string text +---Returns the text of the currently viewed text item. Used for readable world objects (plaques, books on tables, etc) and readable inventory items (looted books/parchments/scrolls/etc, saved copies of mail messages). Returns valid data only between the ITEM_TEXT_BEGIN and ITEM_TEXT_CLOSED events, with the ITEM_TEXT_READY event indicating when new text is available (as when changing pages). +function ItemTextGetText() end \ No newline at end of file diff --git a/api/ItemTextHasNextPage.lua b/api/ItemTextHasNextPage.lua new file mode 100644 index 0000000..4c1f192 --- /dev/null +++ b/api/ItemTextHasNextPage.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil next +---Returns whether the currently viewed text item has additional pages +function ItemTextHasNextPage() end \ No newline at end of file diff --git a/api/ItemTextNextPage.lua b/api/ItemTextNextPage.lua new file mode 100644 index 0000000..ae881bd --- /dev/null +++ b/api/ItemTextNextPage.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Moves to the next page in the currently viewed text item. The ITEM_TEXT_READY event fires when text for the next page becomes available. Does nothing if already viewing the last page of text. +function ItemTextNextPage() end \ No newline at end of file diff --git a/api/ItemTextPrevPage.lua b/api/ItemTextPrevPage.lua new file mode 100644 index 0000000..d3b127a --- /dev/null +++ b/api/ItemTextPrevPage.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Moves to the previous page in the currently viewed text item. The ITEM_TEXT_READY event fires when text for the previous page becomes available. Does nothing if already viewing the first page of text. +function ItemTextPrevPage() end \ No newline at end of file diff --git a/api/JoinArena.lua b/api/JoinArena.lua new file mode 100644 index 0000000..3c45669 --- /dev/null +++ b/api/JoinArena.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function JoinArena() end \ No newline at end of file diff --git a/api/JoinBattlefield.lua b/api/JoinBattlefield.lua new file mode 100644 index 0000000..e89ea69 --- /dev/null +++ b/api/JoinBattlefield.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param asGroup boolean +---Joins the queue for a battleground instance +function JoinBattlefield(index, asGroup) end \ No newline at end of file diff --git a/api/JoinChannelByName.lua b/api/JoinChannelByName.lua new file mode 100644 index 0000000..40d614e --- /dev/null +++ b/api/JoinChannelByName.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function JoinChannelByName() end \ No newline at end of file diff --git a/api/JoinLFG.lua b/api/JoinLFG.lua new file mode 100644 index 0000000..41eae6a --- /dev/null +++ b/api/JoinLFG.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Joins the player to the LFG system. This function just signals to the server that the player is joining the LFG system. In order to actually queue for any dungeons, the SetLFGDungeon function must be called for each dungeon the player wishes to queue for. For the 'random dungeon' queues, these are a single numeric identifier that will queue the player for any of the dungeons in that category. You can obtain this number by opening the LFD frame and running /dump LFDQueueFrame.type. +function JoinLFG() end \ No newline at end of file diff --git a/api/JoinPermanentChannel.lua b/api/JoinPermanentChannel.lua new file mode 100644 index 0000000..492ed72 --- /dev/null +++ b/api/JoinPermanentChannel.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param password string +---@param chatFrameIndex number +---@param enableVoice boolean +---@return number zoneChannel +---@return string channelName +---Joins a channel, saving associated chat window settings +function JoinPermanentChannel(name, password, chatFrameIndex, enableVoice) end \ No newline at end of file diff --git a/api/JoinRatedBattlefield.lua b/api/JoinRatedBattlefield.lua new file mode 100644 index 0000000..c015566 --- /dev/null +++ b/api/JoinRatedBattlefield.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function JoinRatedBattlefield() end \ No newline at end of file diff --git a/api/JoinSingleLFG.lua b/api/JoinSingleLFG.lua new file mode 100644 index 0000000..5e2dff1 --- /dev/null +++ b/api/JoinSingleLFG.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function JoinSingleLFG() end \ No newline at end of file diff --git a/api/JoinSkirmish.lua b/api/JoinSkirmish.lua new file mode 100644 index 0000000..3bd6abd --- /dev/null +++ b/api/JoinSkirmish.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function JoinSkirmish() end \ No newline at end of file diff --git a/api/JoinTemporaryChannel.lua b/api/JoinTemporaryChannel.lua new file mode 100644 index 0000000..89e716b --- /dev/null +++ b/api/JoinTemporaryChannel.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param channel string +---Joins a channel, but does not save associated chat window settings +function JoinTemporaryChannel(channel) end \ No newline at end of file diff --git a/api/JumpOrAscendStart.lua b/api/JumpOrAscendStart.lua new file mode 100644 index 0000000..6ed7643 --- /dev/null +++ b/api/JumpOrAscendStart.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Causes the player character to jump (or begins ascent if swimming or flying). Used by the JUMP binding, which also controls ascent when swimming or flying. +function JumpOrAscendStart() end \ No newline at end of file diff --git a/api/KBArticle_BeginLoading.lua b/api/KBArticle_BeginLoading.lua new file mode 100644 index 0000000..6637a77 --- /dev/null +++ b/api/KBArticle_BeginLoading.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param articleId number +---@param searchType 2 +---@param 1 +---@param 2 +---Requests a specific knowledge base article from the server +function KBArticle_BeginLoading(articleId, searchType, 1, 2) end \ No newline at end of file diff --git a/api/KBArticle_GetData.lua b/api/KBArticle_GetData.lua new file mode 100644 index 0000000..f6c6ed8 --- /dev/null +++ b/api/KBArticle_GetData.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number id +---@return string subject +---@return string subjectAlt +---@return string text +---@return string keywords +---@return number languageId +---@return boolean isHot +---Returns information about the last requested knowledge base article. Only available once the KNOWLEDGE_BASE_ARTICLE_LOAD_SUCCESS event has fired following an article request. +function KBArticle_GetData() end \ No newline at end of file diff --git a/api/KBArticle_IsLoaded.lua b/api/KBArticle_IsLoaded.lua new file mode 100644 index 0000000..bad23c2 --- /dev/null +++ b/api/KBArticle_IsLoaded.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean isLoaded +---Returns whether the requested knowledge base article has been loaded. The KNOWLEDGE_BASE_ARTICLE_LOAD_SUCCESS also indicates that the requested article is available; this function presents an alternative that can be used across UI reloads or login/logout. +function KBArticle_IsLoaded() end \ No newline at end of file diff --git a/api/KBQuery_BeginLoading.lua b/api/KBQuery_BeginLoading.lua new file mode 100644 index 0000000..4e248c0 --- /dev/null +++ b/api/KBQuery_BeginLoading.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param searchText string +---@param categoryIndex number +---@param subcategoryIndex number +---@param numArticles number +---@param page number +---Queries the knowledge base server for articles +function KBQuery_BeginLoading(searchText, categoryIndex, subcategoryIndex, numArticles, page) end \ No newline at end of file diff --git a/api/KBQuery_GetArticleHeaderCount.lua b/api/KBQuery_GetArticleHeaderCount.lua new file mode 100644 index 0000000..ea7fb24 --- /dev/null +++ b/api/KBQuery_GetArticleHeaderCount.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number articleHeaderCount +---Returns the number of articles on the current knowledge base search result page +function KBQuery_GetArticleHeaderCount() end \ No newline at end of file diff --git a/api/KBQuery_GetArticleHeaderData.lua b/api/KBQuery_GetArticleHeaderData.lua new file mode 100644 index 0000000..0b9313f --- /dev/null +++ b/api/KBQuery_GetArticleHeaderData.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number articleId +---@return string title +---@return boolean isHotIssue +---@return boolean isRecentlyUpdated +---Returns information about an article returned in a knowledge base query +function KBQuery_GetArticleHeaderData(index) end \ No newline at end of file diff --git a/api/KBQuery_GetTotalArticleCount.lua b/api/KBQuery_GetTotalArticleCount.lua new file mode 100644 index 0000000..9dd841f --- /dev/null +++ b/api/KBQuery_GetTotalArticleCount.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number totalArticleHeaderCount +---Returns the total number of articles returned for the given query +function KBQuery_GetTotalArticleCount() end \ No newline at end of file diff --git a/api/KBQuery_IsLoaded.lua b/api/KBQuery_IsLoaded.lua new file mode 100644 index 0000000..6a84000 --- /dev/null +++ b/api/KBQuery_IsLoaded.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean isLoaded +---Returns whether results of a knowledge base query have been loaded. The KNOWLEDGE_BASE_QUERY_LOAD_SUCCESS also indicates that the requested results are available; this function presents an alternative that can be used across UI reloads or login/logout. +function KBQuery_IsLoaded() end \ No newline at end of file diff --git a/api/KBSetup_BeginLoading.lua b/api/KBSetup_BeginLoading.lua new file mode 100644 index 0000000..ee152f1 --- /dev/null +++ b/api/KBSetup_BeginLoading.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param numArticles number +---@param currentPage number +---Loads a maximum number of "Top Issues" from a given page +function KBSetup_BeginLoading(numArticles, currentPage) end \ No newline at end of file diff --git a/api/KBSetup_GetArticleHeaderCount.lua b/api/KBSetup_GetArticleHeaderCount.lua new file mode 100644 index 0000000..19ee17c --- /dev/null +++ b/api/KBSetup_GetArticleHeaderCount.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number articleHeaderCount +---Returns the number of "Top Issues" articles on the current page +function KBSetup_GetArticleHeaderCount() end \ No newline at end of file diff --git a/api/KBSetup_GetArticleHeaderData.lua b/api/KBSetup_GetArticleHeaderData.lua new file mode 100644 index 0000000..b81626d --- /dev/null +++ b/api/KBSetup_GetArticleHeaderData.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number articleId +---@return string title +---@return boolean isHotIssue +---@return boolean isRecentlyUpdated +---Returns header information about a "Top Issue" article +function KBSetup_GetArticleHeaderData(index) end \ No newline at end of file diff --git a/api/KBSetup_GetCategoryCount.lua b/api/KBSetup_GetCategoryCount.lua new file mode 100644 index 0000000..9e14fd7 --- /dev/null +++ b/api/KBSetup_GetCategoryCount.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numCategories +---Returns the number of available knowledge base categories +function KBSetup_GetCategoryCount() end \ No newline at end of file diff --git a/api/KBSetup_GetCategoryData.lua b/api/KBSetup_GetCategoryData.lua new file mode 100644 index 0000000..56aa18b --- /dev/null +++ b/api/KBSetup_GetCategoryData.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number categoryId +---@return string name +---Returns information about a knowledge base category +function KBSetup_GetCategoryData(index) end \ No newline at end of file diff --git a/api/KBSetup_GetLanguageCount.lua b/api/KBSetup_GetLanguageCount.lua new file mode 100644 index 0000000..1fb1084 --- /dev/null +++ b/api/KBSetup_GetLanguageCount.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numLanguages +---Returns the number of available knowledge base languages +function KBSetup_GetLanguageCount() end \ No newline at end of file diff --git a/api/KBSetup_GetLanguageData.lua b/api/KBSetup_GetLanguageData.lua new file mode 100644 index 0000000..442c318 --- /dev/null +++ b/api/KBSetup_GetLanguageData.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number languageId +---@return string name +---Returns information about a given knowledge base language +function KBSetup_GetLanguageData(index) end \ No newline at end of file diff --git a/api/KBSetup_GetSubCategoryCount.lua b/api/KBSetup_GetSubCategoryCount.lua new file mode 100644 index 0000000..614a2fb --- /dev/null +++ b/api/KBSetup_GetSubCategoryCount.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number numSubCategories +---Returns the number of available subcategories for a given category +function KBSetup_GetSubCategoryCount(index) end \ No newline at end of file diff --git a/api/KBSetup_GetSubCategoryData.lua b/api/KBSetup_GetSubCategoryData.lua new file mode 100644 index 0000000..d8529a5 --- /dev/null +++ b/api/KBSetup_GetSubCategoryData.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param subindex number +---@return number categoryId +---@return string name +---Returns information a knowledge base subcategory +function KBSetup_GetSubCategoryData(index, subindex) end \ No newline at end of file diff --git a/api/KBSetup_GetTotalArticleCount.lua b/api/KBSetup_GetTotalArticleCount.lua new file mode 100644 index 0000000..82aa003 --- /dev/null +++ b/api/KBSetup_GetTotalArticleCount.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numArticles +---Returns the number of "Top Issues" articles +function KBSetup_GetTotalArticleCount() end \ No newline at end of file diff --git a/api/KBSetup_IsLoaded.lua b/api/KBSetup_IsLoaded.lua new file mode 100644 index 0000000..34c0fd1 --- /dev/null +++ b/api/KBSetup_IsLoaded.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean isLoaded +---Returns whether the knowledge base default query has completed successfully. The KNOWLEDGE_BASE_SETUP_LOAD_SUCCESS also indicates that the knowledge base setup is complete; this function presents an alternative that can be used across UI reloads or login/logout. +function KBSetup_IsLoaded() end \ No newline at end of file diff --git a/api/KBSystem_GetMOTD.lua b/api/KBSystem_GetMOTD.lua new file mode 100644 index 0000000..abb9884 --- /dev/null +++ b/api/KBSystem_GetMOTD.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string text +---Returns the currently knowledge base MOTD +function KBSystem_GetMOTD() end \ No newline at end of file diff --git a/api/KBSystem_GetServerNotice.lua b/api/KBSystem_GetServerNotice.lua new file mode 100644 index 0000000..baceec8 --- /dev/null +++ b/api/KBSystem_GetServerNotice.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string text +---Returns the text of the knowledge base server system notice +function KBSystem_GetServerNotice() end \ No newline at end of file diff --git a/api/KBSystem_GetServerStatus.lua b/api/KBSystem_GetServerStatus.lua new file mode 100644 index 0000000..50901f3 --- /dev/null +++ b/api/KBSystem_GetServerStatus.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string statusMessage +---Returns the knowledge base server system status message +function KBSystem_GetServerStatus() end \ No newline at end of file diff --git a/api/LFGTeleport.lua b/api/LFGTeleport.lua new file mode 100644 index 0000000..f88f449 --- /dev/null +++ b/api/LFGTeleport.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param portOut boolean +---Teleports the player to or from their current LFG dungeon +function LFGTeleport(portOut) end \ No newline at end of file diff --git a/api/LearnTalent.lua b/api/LearnTalent.lua new file mode 100644 index 0000000..9041898 --- /dev/null +++ b/api/LearnTalent.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param tabIndex number +---@param talentIndex number +---@param isPet boolean +---@param talentGroup nil +---@param 1 +---@param 2 +---@param nil +---Learns a talent, spending one talent point +function LearnTalent(tabIndex, talentIndex, isPet, talentGroup, 1, 2, nil) end \ No newline at end of file diff --git a/api/LearnTalents.lua b/api/LearnTalents.lua new file mode 100644 index 0000000..be8a745 --- /dev/null +++ b/api/LearnTalents.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function LearnTalents() end \ No newline at end of file diff --git a/api/LeaveBattlefield.lua b/api/LeaveBattlefield.lua new file mode 100644 index 0000000..51e3dd0 --- /dev/null +++ b/api/LeaveBattlefield.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Immediately exits the current battleground instance. Returns the player to the location from which he or she joined the battleground and applies the Deserter debuff. +function LeaveBattlefield() end \ No newline at end of file diff --git a/api/LeaveChannelByName.lua b/api/LeaveChannelByName.lua new file mode 100644 index 0000000..723037c --- /dev/null +++ b/api/LeaveChannelByName.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---Leaves a chat channel +function LeaveChannelByName(name) end \ No newline at end of file diff --git a/api/LeaveLFG.lua b/api/LeaveLFG.lua new file mode 100644 index 0000000..474bb85 --- /dev/null +++ b/api/LeaveLFG.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Leave the LFG queue. +function LeaveLFG() end \ No newline at end of file diff --git a/api/LeaveParty.lua b/api/LeaveParty.lua new file mode 100644 index 0000000..a525e97 --- /dev/null +++ b/api/LeaveParty.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Exits the current party or raid. If there are only two characters in the party or raid, causes the party or raid to be disbanded. +function LeaveParty() end \ No newline at end of file diff --git a/api/LeaveSingleLFG.lua b/api/LeaveSingleLFG.lua new file mode 100644 index 0000000..4ad8afa --- /dev/null +++ b/api/LeaveSingleLFG.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function LeaveSingleLFG() end \ No newline at end of file diff --git a/api/ListChannelByName.lua b/api/ListChannelByName.lua new file mode 100644 index 0000000..6add1aa --- /dev/null +++ b/api/ListChannelByName.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param channel string +---@param channelIndex number +---Requests the list of participants in a chat channel. Fires the CHAT_MSG_CHANNEL_LIST event listing the names of all characters in the channel. +function ListChannelByName(channel, channelIndex) end \ No newline at end of file diff --git a/api/ListChannels.lua b/api/ListChannels.lua new file mode 100644 index 0000000..65e25de --- /dev/null +++ b/api/ListChannels.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Requests a list of channels joined by the player. Fires the CHAT_MSG_CHANNEL_LIST event listing the names and indices of all channels joined by the player. +function ListChannels() end \ No newline at end of file diff --git a/api/LoadAddOn.lua b/api/LoadAddOn.lua new file mode 100644 index 0000000..ec76308 --- /dev/null +++ b/api/LoadAddOn.lua @@ -0,0 +1,24 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param index number +---@return number loaded +---@return NOT_DEMAND_LOADED reason +---@return BANNED +---@return CORRUPT +---@return DEP_BANNED +---@return DEP_CORRUPT +---@return DEP_DISABLED +---@return DEP_INCOMPATIBLE +---@return DEP_INSECURE +---@return DEP_INTERFACE_VERSION +---@return DEP_MISSING +---@return DEP_NOT_DEMAND_LOADED +---@return DISABLED +---@return INCOMPATIBLE +---@return INSECURE +---@return INTERFACE_VERSION +---@return MISSING +---@return NOT_DEMAND_LOADED +---Loads a LoadOnDemand-capable addon. If the given addon has dependencies which are also LoadOnDemand-capable, those addons will be loaded as well. This function will not load disabled addons. +function LoadAddOn(name, index) end \ No newline at end of file diff --git a/api/LoadBindings.lua b/api/LoadBindings.lua new file mode 100644 index 0000000..1a01e26 --- /dev/null +++ b/api/LoadBindings.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param set 2 +---@param 0 +---@param 1 +---@param 2 +---Loads a set of key bindings. The UPDATE_BINDINGS event fires when the new bindings have taken effect. +function LoadBindings(set, 0, 1, 2) end \ No newline at end of file diff --git a/api/LoggingChat.lua b/api/LoggingChat.lua new file mode 100644 index 0000000..583454d --- /dev/null +++ b/api/LoggingChat.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param toggle boolean +---@return 1nil isLogging +---Enables or disables saving chat text to a file. Text received via the chat system (but not necessarily all text displayed in chat windows) will be saved to the file Logs/WoWChatLog.txt (path is relative to the folder containing the World of Warcraft client); the file is not actually updated until the player logs out. Chat text in the log file follows a similar format to its display in-game, but with added timestamps. +function LoggingChat(toggle) end \ No newline at end of file diff --git a/api/LoggingCombat.lua b/api/LoggingCombat.lua new file mode 100644 index 0000000..687dd0a --- /dev/null +++ b/api/LoggingCombat.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param toggle boolean +---@return 1nil isLogging +---Enables or disables saving combat log data to a file. Combat log data will be saved to the file Logs/WoWCombatLog.txt (path is relative to the folder containing the World of Warcraft client); the file is not actually updated until the player logs out. +function LoggingCombat(toggle) end \ No newline at end of file diff --git a/api/Logout.lua b/api/Logout.lua new file mode 100644 index 0000000..d7d4ced --- /dev/null +++ b/api/Logout.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Attempts to log out and return to the character selection screen. Results vary based on current conditions: If the player is in combat or under other temporary restrictions (e.g. falling), fires the UI_ERROR_MESSAGE event with a message indicating the player cannot log out at the moment. If the player is not in an inn, major city, or other "rest" area (i.e. IsResting() returns nil), fires the PLAYER_CAMPING event, causing the default UI to show a countdown, logging the player out after a period of time if not canceled. If the player is in a "rest" area, logs out immediately. +function Logout() end \ No newline at end of file diff --git a/api/LootSlot.lua b/api/LootSlot.lua new file mode 100644 index 0000000..d994dab --- /dev/null +++ b/api/LootSlot.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---Attempts to pick up an item available as loot. If the item in the loot slot binds on pickup, the LOOT_BIND_CONFIRM event fires, indicating that ConfirmLootSlot(slot) must be called in order to actually loot the item. Please note: if you call this while processing a LOOT_OPENED event and it is the last item to be looted from the corpse, can cause LOOT_CLOSED to fire and be processed before your LOOT_OPENED event handler completes. +function LootSlot(slot) end \ No newline at end of file diff --git a/api/LootSlotHasItem.lua b/api/LootSlotHasItem.lua new file mode 100644 index 0000000..86d4c90 --- /dev/null +++ b/api/LootSlotHasItem.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function LootSlotHasItem() end \ No newline at end of file diff --git a/api/MacOptions_AreOSShortcutsDisabled.lua b/api/MacOptions_AreOSShortcutsDisabled.lua new file mode 100644 index 0000000..1625ee9 --- /dev/null +++ b/api/MacOptions_AreOSShortcutsDisabled.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function MacOptions_AreOSShortcutsDisabled() end \ No newline at end of file diff --git a/api/MacOptions_GetGameBundleName.lua b/api/MacOptions_GetGameBundleName.lua new file mode 100644 index 0000000..1b90596 --- /dev/null +++ b/api/MacOptions_GetGameBundleName.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function MacOptions_GetGameBundleName() end \ No newline at end of file diff --git a/api/MacOptions_HasNewStyleUniversalAccess.lua b/api/MacOptions_HasNewStyleUniversalAccess.lua new file mode 100644 index 0000000..e175757 --- /dev/null +++ b/api/MacOptions_HasNewStyleUniversalAccess.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function MacOptions_HasNewStyleUniversalAccess() end \ No newline at end of file diff --git a/api/MacOptions_IsUniversalAccessEnabled.lua b/api/MacOptions_IsUniversalAccessEnabled.lua new file mode 100644 index 0000000..31b3400 --- /dev/null +++ b/api/MacOptions_IsUniversalAccessEnabled.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function MacOptions_IsUniversalAccessEnabled() end \ No newline at end of file diff --git a/api/MacOptions_OpenUniversalAccess.lua b/api/MacOptions_OpenUniversalAccess.lua new file mode 100644 index 0000000..7643507 --- /dev/null +++ b/api/MacOptions_OpenUniversalAccess.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function MacOptions_OpenUniversalAccess() end \ No newline at end of file diff --git a/api/MacOptions_SetOSShortcutsDisabled.lua b/api/MacOptions_SetOSShortcutsDisabled.lua new file mode 100644 index 0000000..45fb87c --- /dev/null +++ b/api/MacOptions_SetOSShortcutsDisabled.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function MacOptions_SetOSShortcutsDisabled() end \ No newline at end of file diff --git a/api/ModifyEquipmentSet.lua b/api/ModifyEquipmentSet.lua new file mode 100644 index 0000000..de1b77d --- /dev/null +++ b/api/ModifyEquipmentSet.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param oldSetName string +---@param newSetName string +---@param icon number +---Modifies the name and icon of an existing equipment set. If a set with the new name already exists, no action will take place. As with SaveEquipmentSet(), you can use set names consisting of more than 16 characters. However, it will be truncated if the user tries to change the sets icon in the default UI afterwards. +function ModifyEquipmentSet(oldSetName, newSetName, icon) end \ No newline at end of file diff --git a/api/MouselookStart.lua b/api/MouselookStart.lua new file mode 100644 index 0000000..2221098 --- /dev/null +++ b/api/MouselookStart.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Enables mouselook mode, in which cursor movement rotates the camera +function MouselookStart() end \ No newline at end of file diff --git a/api/MouselookStop.lua b/api/MouselookStop.lua new file mode 100644 index 0000000..fff5f0b --- /dev/null +++ b/api/MouselookStop.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Disables mouselook mode +function MouselookStop() end \ No newline at end of file diff --git a/api/MoveAndSteerStart.lua b/api/MoveAndSteerStart.lua new file mode 100644 index 0000000..e280c33 --- /dev/null +++ b/api/MoveAndSteerStart.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Begins moving the player character forward while steering via mouse movement. After calling this function, the player character begins moving forward while cursor movement rotates (or steers) the character, altering yaw (facing) and/or pitch (vertical movement angle) as well as camera position. Equivalent to calling both CameraOrSelectOrMoveStart and TurnOrActionStart without calling the respective Stop functions; i.e. holding both left and right mouse buttons down. Used by the MOVEANDSTEER binding, which can be customized to allow alternate access to this action if the player's system does not allow pressing multiple mouse buttons at once. +function MoveAndSteerStart() end \ No newline at end of file diff --git a/api/MoveAndSteerStop.lua b/api/MoveAndSteerStop.lua new file mode 100644 index 0000000..b2f5362 --- /dev/null +++ b/api/MoveAndSteerStop.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends movement initiated by MoveAndSteerStart. After calling this function, forward movement and character steering stops and normal cursor movement resumes. Used by the MOVEANDSTEER binding. +function MoveAndSteerStop() end \ No newline at end of file diff --git a/api/MoveBackwardStart.lua b/api/MoveBackwardStart.lua new file mode 100644 index 0000000..2cebd86 --- /dev/null +++ b/api/MoveBackwardStart.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Begins moving the player character backward. Used by the MOVEBACKWARD binding. +function MoveBackwardStart() end \ No newline at end of file diff --git a/api/MoveBackwardStop.lua b/api/MoveBackwardStop.lua new file mode 100644 index 0000000..874538d --- /dev/null +++ b/api/MoveBackwardStop.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends movement initiated by MoveBackwardStart +function MoveBackwardStop() end \ No newline at end of file diff --git a/api/MoveForwardStart.lua b/api/MoveForwardStart.lua new file mode 100644 index 0000000..b3f5630 --- /dev/null +++ b/api/MoveForwardStart.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Begins moving the player character forward. Used by the MOVEFORWARD binding. +function MoveForwardStart() end \ No newline at end of file diff --git a/api/MoveForwardStop.lua b/api/MoveForwardStop.lua new file mode 100644 index 0000000..ffd95fe --- /dev/null +++ b/api/MoveForwardStop.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends movement initiated by MoveForwardStart +function MoveForwardStop() end \ No newline at end of file diff --git a/api/MoveViewDownStart.lua b/api/MoveViewDownStart.lua new file mode 100644 index 0000000..d6aeb0a --- /dev/null +++ b/api/MoveViewDownStart.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Begins orbiting the camera downward (to look upward) +function MoveViewDownStart() end \ No newline at end of file diff --git a/api/MoveViewDownStop.lua b/api/MoveViewDownStop.lua new file mode 100644 index 0000000..628058b --- /dev/null +++ b/api/MoveViewDownStop.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends camera movement initiated by MoveViewDownStart +function MoveViewDownStop() end \ No newline at end of file diff --git a/api/MoveViewInStart.lua b/api/MoveViewInStart.lua new file mode 100644 index 0000000..9ee9125 --- /dev/null +++ b/api/MoveViewInStart.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Begins zooming the camera inward (towards/through the player character) +function MoveViewInStart() end \ No newline at end of file diff --git a/api/MoveViewInStop.lua b/api/MoveViewInStop.lua new file mode 100644 index 0000000..b0f22ea --- /dev/null +++ b/api/MoveViewInStop.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends camera movement initiated by MoveViewInStart +function MoveViewInStop() end \ No newline at end of file diff --git a/api/MoveViewLeftStart.lua b/api/MoveViewLeftStart.lua new file mode 100644 index 0000000..14f635a --- /dev/null +++ b/api/MoveViewLeftStart.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Begins orbiting the camera around the player character to the left. "Left" here is relative to the player's facing; i.e. the camera orbits clockwise if looking down. Moving the camera to the left causes it to look towards the character's right. +function MoveViewLeftStart() end \ No newline at end of file diff --git a/api/MoveViewLeftStop.lua b/api/MoveViewLeftStop.lua new file mode 100644 index 0000000..9e1233c --- /dev/null +++ b/api/MoveViewLeftStop.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends camera movement initiated by MoveViewLeftStart +function MoveViewLeftStop() end \ No newline at end of file diff --git a/api/MoveViewOutStart.lua b/api/MoveViewOutStart.lua new file mode 100644 index 0000000..8e098e1 --- /dev/null +++ b/api/MoveViewOutStart.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Begins zooming the camera outward (away from the player character) +function MoveViewOutStart() end \ No newline at end of file diff --git a/api/MoveViewOutStop.lua b/api/MoveViewOutStop.lua new file mode 100644 index 0000000..0735a4f --- /dev/null +++ b/api/MoveViewOutStop.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends camera movement initiated by MoveViewOutStart +function MoveViewOutStop() end \ No newline at end of file diff --git a/api/MoveViewRightStart.lua b/api/MoveViewRightStart.lua new file mode 100644 index 0000000..b84f94c --- /dev/null +++ b/api/MoveViewRightStart.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Begins orbiting the camera around the player character to the right. "Right" here is relative to the player's facing; i.e. the camera orbits counter--clockwise if looking down. Moving the camera to the right causes it to look towards the character's left. +function MoveViewRightStart() end \ No newline at end of file diff --git a/api/MoveViewRightStop.lua b/api/MoveViewRightStop.lua new file mode 100644 index 0000000..f2506cf --- /dev/null +++ b/api/MoveViewRightStop.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends camera movement initiated by MoveViewRightStart +function MoveViewRightStop() end \ No newline at end of file diff --git a/api/MoveViewUpStart.lua b/api/MoveViewUpStart.lua new file mode 100644 index 0000000..77ef332 --- /dev/null +++ b/api/MoveViewUpStart.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Begins orbiting the camera upward (to look down) +function MoveViewUpStart() end \ No newline at end of file diff --git a/api/MoveViewUpStop.lua b/api/MoveViewUpStop.lua new file mode 100644 index 0000000..295cf09 --- /dev/null +++ b/api/MoveViewUpStop.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends camera movement initiated by MoveViewUpStart +function MoveViewUpStop() end \ No newline at end of file diff --git a/api/MovieRecording_Cancel.lua b/api/MovieRecording_Cancel.lua new file mode 100644 index 0000000..4602075 --- /dev/null +++ b/api/MovieRecording_Cancel.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Cancels video recording and compression. If a recording is in progress, recording is stopped and the results discarded. If compression is in progress, compression is stopped and the uncompressed portion of the movie is deleted. +function MovieRecording_Cancel() end \ No newline at end of file diff --git a/api/MovieRecording_DataRate.lua b/api/MovieRecording_DataRate.lua new file mode 100644 index 0000000..4e6fa43 --- /dev/null +++ b/api/MovieRecording_DataRate.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param width number +---@param framerate number +---@param sound number +---@return string dataRate +---Returns the data rate required for a given set of video recording parameters. The value returned is a prediction of the rate at which data will be written to the hard drive while recording -- if the hardware cannot support this data rate, game performance may suffer and recording may stop. +function MovieRecording_DataRate(width, framerate, sound) end \ No newline at end of file diff --git a/api/MovieRecording_DeleteMovie.lua b/api/MovieRecording_DeleteMovie.lua new file mode 100644 index 0000000..4977e73 --- /dev/null +++ b/api/MovieRecording_DeleteMovie.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param filename string +---Deletes an uncompressed movie +function MovieRecording_DeleteMovie(filename) end \ No newline at end of file diff --git a/api/MovieRecording_GetAspectRatio.lua b/api/MovieRecording_GetAspectRatio.lua new file mode 100644 index 0000000..50377f5 --- /dev/null +++ b/api/MovieRecording_GetAspectRatio.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number ratio +---Returns the aspect ratio of the game display. Used in the default UI to calculate dimensions for scaling captured video to predetermined widths. For example, if the aspect ratio is 0.75 (as on a 1600x1200 screen), a movie scaled to 640 pixels wide will be 480 pixels tall; but if the aspect ratio is 0.625 (as on a 1440x900 screen), a movie scaled to 640 pixels wide will be 400 pixels tall. +function MovieRecording_GetAspectRatio() end \ No newline at end of file diff --git a/api/MovieRecording_GetFullWidth.lua b/api/MovieRecording_GetFullWidth.lua new file mode 100644 index 0000000..64fd987 --- /dev/null +++ b/api/MovieRecording_GetFullWidth.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function MovieRecording_GetFullWidth() end \ No newline at end of file diff --git a/api/MovieRecording_GetHalfWidth.lua b/api/MovieRecording_GetHalfWidth.lua new file mode 100644 index 0000000..024ec6b --- /dev/null +++ b/api/MovieRecording_GetHalfWidth.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function MovieRecording_GetHalfWidth() end \ No newline at end of file diff --git a/api/MovieRecording_GetMovieFullPath.lua b/api/MovieRecording_GetMovieFullPath.lua new file mode 100644 index 0000000..5035295 --- /dev/null +++ b/api/MovieRecording_GetMovieFullPath.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string path +---Returns a path to the movie currently being recorded or compressed. If no movie is being recorded or compressed, returns either the empty string ("") or the path of the last movie recorded/compressed. +function MovieRecording_GetMovieFullPath() end \ No newline at end of file diff --git a/api/MovieRecording_GetProgress.lua b/api/MovieRecording_GetProgress.lua new file mode 100644 index 0000000..4288a17 --- /dev/null +++ b/api/MovieRecording_GetProgress.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean recovering +---@return number progress +---Returns information about movie compression progress +function MovieRecording_GetProgress() end \ No newline at end of file diff --git a/api/MovieRecording_GetQuarterWidth.lua b/api/MovieRecording_GetQuarterWidth.lua new file mode 100644 index 0000000..f7d1024 --- /dev/null +++ b/api/MovieRecording_GetQuarterWidth.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function MovieRecording_GetQuarterWidth() end \ No newline at end of file diff --git a/api/MovieRecording_GetSelectedWidth.lua b/api/MovieRecording_GetSelectedWidth.lua new file mode 100644 index 0000000..7f38a53 --- /dev/null +++ b/api/MovieRecording_GetSelectedWidth.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function MovieRecording_GetSelectedWidth() end \ No newline at end of file diff --git a/api/MovieRecording_GetTime.lua b/api/MovieRecording_GetTime.lua new file mode 100644 index 0000000..40ccd53 --- /dev/null +++ b/api/MovieRecording_GetTime.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string time +---Returns the amount of time since video recording was last started. Used in the default UI to show the length of the recording in progress when mousing over the recording indicator on the minimap. May return a nonsensical value if no video has been recorded since logging in. +function MovieRecording_GetTime() end \ No newline at end of file diff --git a/api/MovieRecording_GetViewportWidth.lua b/api/MovieRecording_GetViewportWidth.lua new file mode 100644 index 0000000..68849ae --- /dev/null +++ b/api/MovieRecording_GetViewportWidth.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number width +---Returns the current width of the game display. Used in the default UI to allow the current screen resolution (or an integral factor thereof) to be selected as the video recording resolution. +function MovieRecording_GetViewportWidth() end \ No newline at end of file diff --git a/api/MovieRecording_GetWidthAt.lua b/api/MovieRecording_GetWidthAt.lua new file mode 100644 index 0000000..4d0ae40 --- /dev/null +++ b/api/MovieRecording_GetWidthAt.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function MovieRecording_GetWidthAt() end \ No newline at end of file diff --git a/api/MovieRecording_GetWidthCount.lua b/api/MovieRecording_GetWidthCount.lua new file mode 100644 index 0000000..00b229e --- /dev/null +++ b/api/MovieRecording_GetWidthCount.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function MovieRecording_GetWidthCount() end \ No newline at end of file diff --git a/api/MovieRecording_IsCodecSupported.lua b/api/MovieRecording_IsCodecSupported.lua new file mode 100644 index 0000000..b95d3b9 --- /dev/null +++ b/api/MovieRecording_IsCodecSupported.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param codecID 1836070006 +---@param 1635148593 +---@param 1768124260 +---@param 1835692129 +---@param 1836070006 +---@return boolean isSupported +---Returns whether a video codec is supported on the current system +function MovieRecording_IsCodecSupported(codecID, 1635148593, 1768124260, 1835692129, 1836070006) end \ No newline at end of file diff --git a/api/MovieRecording_IsCompressing.lua b/api/MovieRecording_IsCompressing.lua new file mode 100644 index 0000000..83a2d9c --- /dev/null +++ b/api/MovieRecording_IsCompressing.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean isCompressing +---Returns whether a movie file is currently being compressed +function MovieRecording_IsCompressing() end \ No newline at end of file diff --git a/api/MovieRecording_IsCursorRecordingSupported.lua b/api/MovieRecording_IsCursorRecordingSupported.lua new file mode 100644 index 0000000..d4799db --- /dev/null +++ b/api/MovieRecording_IsCursorRecordingSupported.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean isSupported +---Returns whether the current system supports recording the mouse cursor in movies +function MovieRecording_IsCursorRecordingSupported() end \ No newline at end of file diff --git a/api/MovieRecording_IsRecording.lua b/api/MovieRecording_IsRecording.lua new file mode 100644 index 0000000..dfab2be --- /dev/null +++ b/api/MovieRecording_IsRecording.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isRecording +---Returns whether movie recording is currently in progress +function MovieRecording_IsRecording() end \ No newline at end of file diff --git a/api/MovieRecording_IsSupported.lua b/api/MovieRecording_IsSupported.lua new file mode 100644 index 0000000..896cf59 --- /dev/null +++ b/api/MovieRecording_IsSupported.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean isSupported +---Returns whether movie recording is supported on the current system +function MovieRecording_IsSupported() end \ No newline at end of file diff --git a/api/MovieRecording_LoadSelectedWidth.lua b/api/MovieRecording_LoadSelectedWidth.lua new file mode 100644 index 0000000..13a630c --- /dev/null +++ b/api/MovieRecording_LoadSelectedWidth.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function MovieRecording_LoadSelectedWidth() end \ No newline at end of file diff --git a/api/MovieRecording_MaxLength.lua b/api/MovieRecording_MaxLength.lua new file mode 100644 index 0000000..7b89241 --- /dev/null +++ b/api/MovieRecording_MaxLength.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param width number +---@param framerate number +---@param sound number +---@return string time +---Returns the maximum length of recorded video for a given set of video recording parameters. The value returned reflects both the data rate associated with the given parameters and the amount of space remaining on the hard drive. +function MovieRecording_MaxLength(width, framerate, sound) end \ No newline at end of file diff --git a/api/MovieRecording_QueueMovieToCompress.lua b/api/MovieRecording_QueueMovieToCompress.lua new file mode 100644 index 0000000..edbdc23 --- /dev/null +++ b/api/MovieRecording_QueueMovieToCompress.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param filename string +---Queues an uncompressed movie for compression. If there are no items currently in the queue the movie will begin compressing immediately. +function MovieRecording_QueueMovieToCompress(filename) end \ No newline at end of file diff --git a/api/MovieRecording_SaveSelectedWidth.lua b/api/MovieRecording_SaveSelectedWidth.lua new file mode 100644 index 0000000..ea55295 --- /dev/null +++ b/api/MovieRecording_SaveSelectedWidth.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function MovieRecording_SaveSelectedWidth() end \ No newline at end of file diff --git a/api/MovieRecording_SearchUncompressedMovie.lua b/api/MovieRecording_SearchUncompressedMovie.lua new file mode 100644 index 0000000..babea7c --- /dev/null +++ b/api/MovieRecording_SearchUncompressedMovie.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param enable boolean +---Enables or disables a search for uncompressed movies. After calling this function with true, a MOVIE_UNCOMPRESSED_MOVIE fires for the first uncompressed movie found (causing the default UI to prompt the user to choose whether to compress, ignore, or delete the movie). Calling this function with false ignores the movie, causing the search to continue (firing a MOVIE_UNCOMPRESSED_MOVIE event for the next uncompressed movie found, and so forth). +function MovieRecording_SearchUncompressedMovie(enable) end \ No newline at end of file diff --git a/api/MovieRecording_SetSelectedWidth.lua b/api/MovieRecording_SetSelectedWidth.lua new file mode 100644 index 0000000..efc746e --- /dev/null +++ b/api/MovieRecording_SetSelectedWidth.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function MovieRecording_SetSelectedWidth() end \ No newline at end of file diff --git a/api/MovieRecording_Toggle.lua b/api/MovieRecording_Toggle.lua new file mode 100644 index 0000000..0df78f9 --- /dev/null +++ b/api/MovieRecording_Toggle.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Begins or ends video recording. Used by the MOVIE_RECORDING_STARTSTOP key binding. +function MovieRecording_Toggle() end \ No newline at end of file diff --git a/api/MovieRecording_ToggleGUI.lua b/api/MovieRecording_ToggleGUI.lua new file mode 100644 index 0000000..3956a08 --- /dev/null +++ b/api/MovieRecording_ToggleGUI.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Enables or disables inclusion of UI elements in a video recording. Equivalent to the MovieRecordingGUI CVar, but provided as a convenience for the MOVIE_RECORDING_GUI so UI recording can be turned on or off while a movie is recording. +function MovieRecording_ToggleGUI() end \ No newline at end of file diff --git a/api/MusicPlayer_BackTrack.lua b/api/MusicPlayer_BackTrack.lua new file mode 100644 index 0000000..196eb0b --- /dev/null +++ b/api/MusicPlayer_BackTrack.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Causes iTunes to return to the previous track played. Used by the iTunes Remote key bindings only available on the Mac OS X WoW client. Only has effect while the iTunes application is open. +function MusicPlayer_BackTrack() end \ No newline at end of file diff --git a/api/MusicPlayer_NextTrack.lua b/api/MusicPlayer_NextTrack.lua new file mode 100644 index 0000000..35d293f --- /dev/null +++ b/api/MusicPlayer_NextTrack.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Causes iTunes to play the next track in sequence. Used by the iTunes Remote key bindings only available on the Mac OS X WoW client. Only has effect while the iTunes application is open. +function MusicPlayer_NextTrack() end \ No newline at end of file diff --git a/api/MusicPlayer_PlayPause.lua b/api/MusicPlayer_PlayPause.lua new file mode 100644 index 0000000..1a46e24 --- /dev/null +++ b/api/MusicPlayer_PlayPause.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Causes iTunes to start or pause playback. Used by the iTunes Remote key bindings only available on the Mac OS X WoW client. Only has effect while the iTunes application is open. +function MusicPlayer_PlayPause() end \ No newline at end of file diff --git a/api/MusicPlayer_VolumeDown.lua b/api/MusicPlayer_VolumeDown.lua new file mode 100644 index 0000000..3142dd8 --- /dev/null +++ b/api/MusicPlayer_VolumeDown.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Causes iTunes to lower its playback volume. Affects the iTunes volume setting only, not the overall system volume or any of WoW's volume settings. Used by the iTunes Remote key bindings only available on the Mac OS X WoW client. Only has effect while the iTunes application is open. +function MusicPlayer_VolumeDown() end \ No newline at end of file diff --git a/api/MusicPlayer_VolumeUp.lua b/api/MusicPlayer_VolumeUp.lua new file mode 100644 index 0000000..9c7fc50 --- /dev/null +++ b/api/MusicPlayer_VolumeUp.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Causes iTunes to raise its playback volume. Affects the iTunes volume setting only, not the overall system volume or any of WoW's volume settings. Used by the iTunes Remote key bindings only available on the Mac OS X WoW client. Only has effect while the iTunes application is open. +function MusicPlayer_VolumeUp() end \ No newline at end of file diff --git a/api/NeutralPlayerSelectFaction.lua b/api/NeutralPlayerSelectFaction.lua new file mode 100644 index 0000000..0355c9a --- /dev/null +++ b/api/NeutralPlayerSelectFaction.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function NeutralPlayerSelectFaction() end \ No newline at end of file diff --git a/api/NewGMTicket.lua b/api/NewGMTicket.lua new file mode 100644 index 0000000..ece3f34 --- /dev/null +++ b/api/NewGMTicket.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param text string +---@param needResponse boolean +---Opens a new GM support ticket. The default UI sets the needResponse flag to true for "Talk to a GM" and "Stuck" tickets, and false for "Report an issue" tickets. +function NewGMTicket(text, needResponse) end \ No newline at end of file diff --git a/api/NextView.lua b/api/NextView.lua new file mode 100644 index 0000000..f9ed096 --- /dev/null +++ b/api/NextView.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Moves the camera to the next predefined setting. There are five "slots" for saved camera settings, indexed 1-5. These views can be set and accessed directly using SaveView() and SetView(), and cycled through using NextView() and PrevView(). +function NextView() end \ No newline at end of file diff --git a/api/NoPlayTime.lua b/api/NoPlayTime.lua new file mode 100644 index 0000000..754d5cb --- /dev/null +++ b/api/NoPlayTime.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil hasNoTime +---Returns whether the player has exceeded the allowed play time limit. When in this state, the player is unable to gain loot or XP or complete quests and cannot use trade skills; returning to normal requires logging out of the game for a period of time (see GetBillingTimeRested). Only used in locales where the length of play sessions is restricted (e.g. mainland China). +function NoPlayTime() end \ No newline at end of file diff --git a/api/NotWhileDeadError.lua b/api/NotWhileDeadError.lua new file mode 100644 index 0000000..d7e2532 --- /dev/null +++ b/api/NotWhileDeadError.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Causes the default UI to display an error message indicating that actions are disallowed while the player is dead. Fires a UI_ERROR_MESSAGE event containing a localized message identified by the global variable ERR_PLAYER_DEAD. +function NotWhileDeadError() end \ No newline at end of file diff --git a/api/NotifyInspect.lua b/api/NotifyInspect.lua new file mode 100644 index 0000000..2168df0 --- /dev/null +++ b/api/NotifyInspect.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---Marks a unit for inspection and requests talent data from the server. Information about the inspected item's equipment can be retrieved immediately using Inventory APIs (e.g. GetInventoryItemLink("target",1)). Talent data is not available immediately; the INSPECT_READY event fires once the inspected unit's talent information can be retrieved using Talent APIs (e.g. GetTalentInfo(1,1,true)). +function NotifyInspect(unit) end \ No newline at end of file diff --git a/api/NumTaxiNodes.lua b/api/NumTaxiNodes.lua new file mode 100644 index 0000000..fa85adc --- /dev/null +++ b/api/NumTaxiNodes.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number numNodes +---Returns the number of flight points on the taxi map. Only returns valid data while interacting with a flight master (i.e. between the TAXIMAP_OPENED and TAXIMAP_CLOSED events). +function NumTaxiNodes() end \ No newline at end of file diff --git a/api/OfferPetition.lua b/api/OfferPetition.lua new file mode 100644 index 0000000..33748c1 --- /dev/null +++ b/api/OfferPetition.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Requests an arena or guild charter signature from the targeted unit +function OfferPetition() end \ No newline at end of file diff --git a/api/OffhandHasWeapon.lua b/api/OffhandHasWeapon.lua new file mode 100644 index 0000000..b7c5b1c --- /dev/null +++ b/api/OffhandHasWeapon.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil hasWeapon +---Returns whether the player has an equipped weapon in the off hand slot +function OffhandHasWeapon() end \ No newline at end of file diff --git a/api/OpenCalendar.lua b/api/OpenCalendar.lua new file mode 100644 index 0000000..30235e1 --- /dev/null +++ b/api/OpenCalendar.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Queries the server for calendar status information. May cause one or more CALENDAR_UPDATE_* events to fire depending on the contents of the player's calendar. In the default UI, called when the calendar is shown. +function OpenCalendar() end \ No newline at end of file diff --git a/api/OpenTrainer.lua b/api/OpenTrainer.lua new file mode 100644 index 0000000..6e94705 --- /dev/null +++ b/api/OpenTrainer.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function OpenTrainer() end \ No newline at end of file diff --git a/api/OpeningCinematic.lua b/api/OpeningCinematic.lua new file mode 100644 index 0000000..c2089c1 --- /dev/null +++ b/api/OpeningCinematic.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Displays the introductory cinematic for the player's race. Only has effect if the player has never gained any experience. +function OpeningCinematic() end \ No newline at end of file diff --git a/api/PartialPlayTime.lua b/api/PartialPlayTime.lua new file mode 100644 index 0000000..c8ec7a9 --- /dev/null +++ b/api/PartialPlayTime.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil partialPlayTime +---Returns whether the player is near the allowed play time limit. When in this state, the player receives half the normal amount of money and XP from kills and quests and cannot use trade skills; returning to normal requires logging out of the game for a period of time (see GetBillingTimeRested). Only used in locales where the length of play sessions is restricted (e.g. mainland China). +function PartialPlayTime() end \ No newline at end of file diff --git a/api/PartyLFGStartBackfill.lua b/api/PartyLFGStartBackfill.lua new file mode 100644 index 0000000..fd8fe0d --- /dev/null +++ b/api/PartyLFGStartBackfill.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function PartyLFGStartBackfill() end \ No newline at end of file diff --git a/api/PetAbandon.lua b/api/PetAbandon.lua new file mode 100644 index 0000000..6672a01 --- /dev/null +++ b/api/PetAbandon.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Releases the player's pet. For Hunter pets, this function sends the pet away, never to return (in the default UI, it's called when accepting the "Are you sure you want to permanently abandon your pet?" dialog). For other pets, this function is equivalent to PetDismiss(). +function PetAbandon() end \ No newline at end of file diff --git a/api/PetAggressiveMode.lua b/api/PetAggressiveMode.lua new file mode 100644 index 0000000..c633c59 --- /dev/null +++ b/api/PetAggressiveMode.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Enables aggressive mode for the player's pet. In this mode, the pet automatically attacks any nearby hostile targets. +function PetAggressiveMode() end \ No newline at end of file diff --git a/api/PetAssistMode.lua b/api/PetAssistMode.lua new file mode 100644 index 0000000..4d08a65 --- /dev/null +++ b/api/PetAssistMode.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function PetAssistMode() end \ No newline at end of file diff --git a/api/PetAttack.lua b/api/PetAttack.lua new file mode 100644 index 0000000..0dfeca6 --- /dev/null +++ b/api/PetAttack.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---Instructs the pet to attack. The pet will attack the player's current target if no unit is specified. +function PetAttack(unit, name) end \ No newline at end of file diff --git a/api/PetCanBeAbandoned.lua b/api/PetCanBeAbandoned.lua new file mode 100644 index 0000000..b428527 --- /dev/null +++ b/api/PetCanBeAbandoned.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil canAbandon +---Returns whether the player's pet can be abandoned. Only Hunter pets can be permanently abandoned. +function PetCanBeAbandoned() end \ No newline at end of file diff --git a/api/PetCanBeDismissed.lua b/api/PetCanBeDismissed.lua new file mode 100644 index 0000000..80137a2 --- /dev/null +++ b/api/PetCanBeDismissed.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil canDismiss +---Returns whether a Dismiss Pet command should be available for the player's pet. Returns 1 for hunter pets even though they use the Dismiss Pet (cast) spell instead of a Dismiss Pet (instant) command; the value of PetCanBeAbandoned() overrides this in causing the default UI to hide the command. Currently unused, but may be used in the future for other pets. +function PetCanBeDismissed() end \ No newline at end of file diff --git a/api/PetCanBeRenamed.lua b/api/PetCanBeRenamed.lua new file mode 100644 index 0000000..fa4a3d4 --- /dev/null +++ b/api/PetCanBeRenamed.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil canRename +---Returns whether the player's pet can be renamed. Only hunter pets can be renamed, and only once (barring use of a Certificate of Ownership). +function PetCanBeRenamed() end \ No newline at end of file diff --git a/api/PetDefensiveMode.lua b/api/PetDefensiveMode.lua new file mode 100644 index 0000000..f9622d7 --- /dev/null +++ b/api/PetDefensiveMode.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Enables defensive mode for the player's pet. In this mode, the pet automatically attacks only units which attack it or the player or units the player is attacking. +function PetDefensiveMode() end \ No newline at end of file diff --git a/api/PetDismiss.lua b/api/PetDismiss.lua new file mode 100644 index 0000000..ba419e2 --- /dev/null +++ b/api/PetDismiss.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Dismisses the currently controlled pet. Used for dismissing Warlock pets, Mind Control targets, etc. Has no effect for Hunter pets, which can only be dismissed using the Dismiss Pet spell. +function PetDismiss() end \ No newline at end of file diff --git a/api/PetFollow.lua b/api/PetFollow.lua new file mode 100644 index 0000000..20a8d5b --- /dev/null +++ b/api/PetFollow.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Instructs the pet to follow the player. If the pet is currently attacking a target, the pet will stop attacking. +function PetFollow() end \ No newline at end of file diff --git a/api/PetHasActionBar.lua b/api/PetHasActionBar.lua new file mode 100644 index 0000000..ecffa62 --- /dev/null +++ b/api/PetHasActionBar.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil hasActionBar +---Returns whether the player's current pet has an action bar +function PetHasActionBar() end \ No newline at end of file diff --git a/api/PetHasSpellbook.lua b/api/PetHasSpellbook.lua new file mode 100644 index 0000000..955deb0 --- /dev/null +++ b/api/PetHasSpellbook.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function PetHasSpellbook() end \ No newline at end of file diff --git a/api/PetMoveTo.lua b/api/PetMoveTo.lua new file mode 100644 index 0000000..b06b2ae --- /dev/null +++ b/api/PetMoveTo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Commands the player's pet to move to the targeted destination. Calling this only brings up the targeting display, the user must perform a second click to actually tell the pet to move. +function PetMoveTo() end \ No newline at end of file diff --git a/api/PetPassiveMode.lua b/api/PetPassiveMode.lua new file mode 100644 index 0000000..a756a02 --- /dev/null +++ b/api/PetPassiveMode.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Enables passive mode for the player's pet. In this mode, the pet will not automatically attack any target. +function PetPassiveMode() end \ No newline at end of file diff --git a/api/PetRename.lua b/api/PetRename.lua new file mode 100644 index 0000000..b09743d --- /dev/null +++ b/api/PetRename.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param genitive string +---@param dative string +---@param accusative string +---@param instrumental string +---@param prepositional string +---Renames the currently controlled pet. Only Hunter pets can be renamed, and a given pet can only be renamed once (barring use of a Certificate of Ownership). +function PetRename(name, genitive, dative, accusative, instrumental, prepositional) end \ No newline at end of file diff --git a/api/PetStopAttack.lua b/api/PetStopAttack.lua new file mode 100644 index 0000000..190ecee --- /dev/null +++ b/api/PetStopAttack.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Instructs the pet to stop attacking +function PetStopAttack() end \ No newline at end of file diff --git a/api/PetUsesPetFrame.lua b/api/PetUsesPetFrame.lua new file mode 100644 index 0000000..acc709c --- /dev/null +++ b/api/PetUsesPetFrame.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function PetUsesPetFrame() end \ No newline at end of file diff --git a/api/PetWait.lua b/api/PetWait.lua new file mode 100644 index 0000000..5bae66c --- /dev/null +++ b/api/PetWait.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Instructs the pet to stay at its current location. If the pet is currently attacking a target, the pet will stop attacking. +function PetWait() end \ No newline at end of file diff --git a/api/PickupAction.lua b/api/PickupAction.lua new file mode 100644 index 0000000..7367bc4 --- /dev/null +++ b/api/PickupAction.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---Puts the contents of an action bar slot onto the cursor or the cursor contents into an action bar slot. After an action is picked up via this function, it can only be placed into other action bar slots (with PlaceAction() or by calling PickupAction() again), even if the action is an item which could otherwise be placed elsewhere. Unlike many other "pickup" cursor functions, this function removes the picked-up action from the source slot -- an action slot can be emptied by calling this function followed by ClearCursor(). If the action slot is empty and the cursor already holds an action, a spell, a companion (mount or non-combat pet), a macro, an equipment set, or an item (with a "Use:" effect), it is put into the action slot. If both the cursor and the slot hold an action (or any of the above data types), the contents of the cursor and the slot are exchanged. +function PickupAction(slot) end \ No newline at end of file diff --git a/api/PickupBagFromSlot.lua b/api/PickupBagFromSlot.lua new file mode 100644 index 0000000..199da48 --- /dev/null +++ b/api/PickupBagFromSlot.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---Puts an equipped container onto the cursor +function PickupBagFromSlot(slot) end \ No newline at end of file diff --git a/api/PickupCompanion.lua b/api/PickupCompanion.lua new file mode 100644 index 0000000..b8995b2 --- /dev/null +++ b/api/PickupCompanion.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param type MOUNT +---@param CRITTER +---@param MOUNT +---@param index number +---Puts a non-combat pet or mount onto the cursor +function PickupCompanion(type, CRITTER, MOUNT, index) end \ No newline at end of file diff --git a/api/PickupContainerItem.lua b/api/PickupContainerItem.lua new file mode 100644 index 0000000..63e7411 --- /dev/null +++ b/api/PickupContainerItem.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param container number +---@param slot number +---Picks up an item from or puts an item into a slot in one of the player's bags or other containers. If the cursor is empty and the referenced container slot contains an item, that item is put onto the cursor. If the cursor contains an item and the slot is empty, the item is placed into the slot. If both the cursor and the slot contain items, the contents of the cursor and the container slot are exchanged. An item picked up from a container is not removed from its slot (until put elsewhere); when an item is picked up, the slot becomes locked, preventing other changes to its contents until the disposition (movement, trade, mailing, auctioning, destruction, etc) of the picked-up item is resolved. +function PickupContainerItem(container, slot) end \ No newline at end of file diff --git a/api/PickupCurrency.lua b/api/PickupCurrency.lua new file mode 100644 index 0000000..5f7990a --- /dev/null +++ b/api/PickupCurrency.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function PickupCurrency() end \ No newline at end of file diff --git a/api/PickupEquipmentSet.lua b/api/PickupEquipmentSet.lua new file mode 100644 index 0000000..9bd8d90 --- /dev/null +++ b/api/PickupEquipmentSet.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Puts an equipment set (specified by index) on the cursor. Can be used to place an equipment set in an action bar slot. +function PickupEquipmentSet(index) end \ No newline at end of file diff --git a/api/PickupEquipmentSetByName.lua b/api/PickupEquipmentSetByName.lua new file mode 100644 index 0000000..8a57b4d --- /dev/null +++ b/api/PickupEquipmentSetByName.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---Puts an equipment set on the cursor. Can be used to place an equipment set in an action bar slot. +function PickupEquipmentSetByName(name) end \ No newline at end of file diff --git a/api/PickupGuildBankItem.lua b/api/PickupGuildBankItem.lua new file mode 100644 index 0000000..088124e --- /dev/null +++ b/api/PickupGuildBankItem.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param tab number +---@param slot number +---Picks up an item from or puts an item into the guild bank. If the cursor is empty and the referenced guild bank slot contains an item, that item is put onto the cursor. If the cursor contains an item and the slot is empty, the item is placed into the slot. If both the cursor and the slot contain items, the contents of the cursor and the guild bank slot are exchanged. +function PickupGuildBankItem(tab, slot) end \ No newline at end of file diff --git a/api/PickupGuildBankMoney.lua b/api/PickupGuildBankMoney.lua new file mode 100644 index 0000000..e6314f6 --- /dev/null +++ b/api/PickupGuildBankMoney.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param amount number +---Puts money from the guild bank onto the cursor. Money is not actually withdrawn from the guild bank; in the default UI, when the cursor "puts" the money into one of the player's bags, it calls WithdrawGuildBankMoney(). +function PickupGuildBankMoney(amount) end \ No newline at end of file diff --git a/api/PickupInventoryItem.lua b/api/PickupInventoryItem.lua new file mode 100644 index 0000000..6c33914 --- /dev/null +++ b/api/PickupInventoryItem.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---Picks up an item from or puts an item into an equipment slot. If the cursor is empty and the referenced inventory slot contains an item, that item is put onto the cursor. If the cursor contains an item (which can be equipped in the slot) and the slot is empty, the item is placed into the slot. If both the cursor and the slot contain items, the contents of the cursor and the inventory slot are exchanged. An item picked up from an inventory slot is not removed from the slot (until put elsewhere); when an item is picked up, the slot becomes locked, preventing other changes to its contents until the disposition (movement, trade, destruction, etc) of the picked-up item is resolved. +function PickupInventoryItem(slot) end \ No newline at end of file diff --git a/api/PickupItem.lua b/api/PickupItem.lua new file mode 100644 index 0000000..6e94cdf --- /dev/null +++ b/api/PickupItem.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemID number +---@param itemName string +---@param itemLink string +---Puts an arbitrary item onto the cursor. Puts an item onto the cursor regardless of its location (equipped, bags, bank or not even in the player's possession); can be used to put an item into an action slot (see PlaceAction()) even if the player does not currently hold the item. Since the item is not picked up from a specific location, this function cannot be used to move an item to another bag, trade it to another player, attach it to a mail message, destroyed, etc. +function PickupItem(itemID, itemName, itemLink) end \ No newline at end of file diff --git a/api/PickupMacro.lua b/api/PickupMacro.lua new file mode 100644 index 0000000..b031185 --- /dev/null +++ b/api/PickupMacro.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param name string +---Puts a macro onto the cursor +function PickupMacro(index, name) end \ No newline at end of file diff --git a/api/PickupMerchantItem.lua b/api/PickupMerchantItem.lua new file mode 100644 index 0000000..1e737d7 --- /dev/null +++ b/api/PickupMerchantItem.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Puts an item available for purchase from a vendor onto the cursor +function PickupMerchantItem(index) end \ No newline at end of file diff --git a/api/PickupPetAction.lua b/api/PickupPetAction.lua new file mode 100644 index 0000000..59181f4 --- /dev/null +++ b/api/PickupPetAction.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Puts the contents of a pet action slot onto the cursor or the cursor contents into a pet action slot. Only pet actions and spells from the "pet" portion of the spellbook can be placed into pet action slots. If the cursor is empty and the referenced pet action slot contains an action, that action is put onto the cursor (but remains in the slot). If the cursor contains a pet action or pet spell and the slot is empty, the action/spell is placed into the slot. If both the cursor and the slot contain pet actions, the contents of the cursor and the pet action slot are exchanged. +function PickupPetAction(index) end \ No newline at end of file diff --git a/api/PickupPetSpell.lua b/api/PickupPetSpell.lua new file mode 100644 index 0000000..41827e0 --- /dev/null +++ b/api/PickupPetSpell.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function PickupPetSpell() end \ No newline at end of file diff --git a/api/PickupPlayerMoney.lua b/api/PickupPlayerMoney.lua new file mode 100644 index 0000000..f61ed04 --- /dev/null +++ b/api/PickupPlayerMoney.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param amount number +---Puts an amount of the player's money onto the cursor. Money is not immediately deducted from the player's total savings (though it appears such on the default UI's money displays, which generally show GetMoney()-GetCursorMoney()). +function PickupPlayerMoney(amount) end \ No newline at end of file diff --git a/api/PickupSpell.lua b/api/PickupSpell.lua new file mode 100644 index 0000000..32a3475 --- /dev/null +++ b/api/PickupSpell.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param spellID number +---Puts a spell onto the cursor +function PickupSpell(spellID) end \ No newline at end of file diff --git a/api/PickupSpellBookItem.lua b/api/PickupSpellBookItem.lua new file mode 100644 index 0000000..b0e3150 --- /dev/null +++ b/api/PickupSpellBookItem.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function PickupSpellBookItem() end \ No newline at end of file diff --git a/api/PickupStablePet.lua b/api/PickupStablePet.lua new file mode 100644 index 0000000..0d6fb37 --- /dev/null +++ b/api/PickupStablePet.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index 1 to NUM_PET_STABLE_SLOTS +---@param 0 +---@param 1 to NUM_PET_STABLE_SLOTS +---Puts a pet from the stables onto the cursor. Use with ClickStablePet to move pets between stabled and active status. +function PickupStablePet(index, 0, 1 to NUM_PET_STABLE_SLOTS) end \ No newline at end of file diff --git a/api/PickupTalent.lua b/api/PickupTalent.lua new file mode 100644 index 0000000..86458fa --- /dev/null +++ b/api/PickupTalent.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function PickupTalent() end \ No newline at end of file diff --git a/api/PickupTradeMoney.lua b/api/PickupTradeMoney.lua new file mode 100644 index 0000000..0f1768c --- /dev/null +++ b/api/PickupTradeMoney.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param amount number +---Puts money offered by the player for trade onto the cursor. Money put onto the cursor is subtracted from the amount offered for trade (see GetPlayerTradeMoney()). +function PickupTradeMoney(amount) end \ No newline at end of file diff --git a/api/PitchDownStart.lua b/api/PitchDownStart.lua new file mode 100644 index 0000000..75b6c00 --- /dev/null +++ b/api/PitchDownStart.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Begins adjusting the player character's angle of vertical movement downward. Affects only the angle or slope of movement for swimming or flying; has no immediately visible effect if the player is not moving, but alters the trajectory followed as soon as the player begins moving. Continuously adjusts pitch until the minimum angle is reached or PitchDownStop() is called. Used by the PITCHDOWN binding. +function PitchDownStart() end \ No newline at end of file diff --git a/api/PitchDownStop.lua b/api/PitchDownStop.lua new file mode 100644 index 0000000..404ac2d --- /dev/null +++ b/api/PitchDownStop.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends movement initiated by PitchDownStart +function PitchDownStop() end \ No newline at end of file diff --git a/api/PitchUpStart.lua b/api/PitchUpStart.lua new file mode 100644 index 0000000..64c1181 --- /dev/null +++ b/api/PitchUpStart.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Begins adjusting the player character's angle of vertical movement upward. Affects only the angle or slope of movement for swimming or flying; has no immediately visible effect if the player is not moving, but alters the trajectory followed as soon as the player begins moving. Continuously adjusts pitch until the maximum angle is reached or PitchUpStop() is called. Used by the PITCHUP binding. +function PitchUpStart() end \ No newline at end of file diff --git a/api/PitchUpStop.lua b/api/PitchUpStop.lua new file mode 100644 index 0000000..aa8b2ea --- /dev/null +++ b/api/PitchUpStop.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends movement initiated by PitchUpStart +function PitchUpStop() end \ No newline at end of file diff --git a/api/PlaceAction.lua b/api/PlaceAction.lua new file mode 100644 index 0000000..90f76c7 --- /dev/null +++ b/api/PlaceAction.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---Puts the contents of the cursor into an action bar slot. If the action slot is empty and the cursor already holds an action, a spell, a companion (mount or non-combat pet), a macro, an equipment set, or an item (with a "Use:" effect), it is put into the action slot. If both the cursor and the slot hold an action (or any of the above data types), the contents of the cursor and the slot are exchanged. Does nothing if the cursor is empty. +function PlaceAction(slot) end \ No newline at end of file diff --git a/api/PlaceAuctionBid.lua b/api/PlaceAuctionBid.lua new file mode 100644 index 0000000..47226dd --- /dev/null +++ b/api/PlaceAuctionBid.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param list owner +---@param bidder +---@param list +---@param owner +---@param index number +---@param bid number +---Places a bid on (or buys out) an auction item. Attempting to bid an amount equal to or greater than the auction's buyout price will buy out the auction (spending only the exact buyout price) instead of placing a bid. +function PlaceAuctionBid(list, bidder, list, owner, index, bid) end \ No newline at end of file diff --git a/api/PlaceGlyphInSocket.lua b/api/PlaceGlyphInSocket.lua new file mode 100644 index 0000000..79e056c --- /dev/null +++ b/api/PlaceGlyphInSocket.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param socket number +---Applies the glyph currently awaiting a target to a socket. Only valid during glyph application: when the player has activated the glyph item but before she has chosen the glyph slot to put it in (i.e. the glowing hand cursor is showing). This function does not ask for confirmation before overwriting an existing glyph. However, calling this function only begins the "spellcast" that applies the glyph, so canceling glyph application is still possible. +function PlaceGlyphInSocket(socket) end \ No newline at end of file diff --git a/api/PlaceRaidMarker.lua b/api/PlaceRaidMarker.lua new file mode 100644 index 0000000..b800b61 --- /dev/null +++ b/api/PlaceRaidMarker.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function PlaceRaidMarker() end \ No newline at end of file diff --git a/api/PlayAutoAcceptQuestSound.lua b/api/PlayAutoAcceptQuestSound.lua new file mode 100644 index 0000000..cd00a7b --- /dev/null +++ b/api/PlayAutoAcceptQuestSound.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function PlayAutoAcceptQuestSound() end \ No newline at end of file diff --git a/api/PlayMusic.lua b/api/PlayMusic.lua new file mode 100644 index 0000000..47fab87 --- /dev/null +++ b/api/PlayMusic.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param musicfile string +---Plays an audio file as background music. Any other background music that is currently playing will be faded out as the new music begins; if the Sound_ZoneMusicNoDelay is set, music will loop continuously until StopMusic() is called. WoW supports WAV, MP3 and Ogg audio formats. +function PlayMusic(musicfile) end \ No newline at end of file diff --git a/api/PlaySound.lua b/api/PlaySound.lua new file mode 100644 index 0000000..016a669 --- /dev/null +++ b/api/PlaySound.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param sound string +---@param soundChannel string +---Plays one of WoW's built-in sound effects. Only supports sounds found in the Sound\Interface directory within WoW's MPQ files; to play other built-in sounds or sounds in an addon directory, use PlaySoundFile(). +function PlaySound(sound, soundChannel) end \ No newline at end of file diff --git a/api/PlaySoundFile.lua b/api/PlaySoundFile.lua new file mode 100644 index 0000000..26fff84 --- /dev/null +++ b/api/PlaySoundFile.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param soundFile string +---@param soundChannel string +---Plays an audio file at a given path. For a shorter way to specify one of WoW's built-in UI sound effects, see PlaySound(). WoW supports custom sound files using Ogg or MP3 audio format. MP3 support was dropped in patch 6.0.2, but added again in patch 6.0.3 +function PlaySoundFile(soundFile, soundChannel) end \ No newline at end of file diff --git a/api/PlaySoundKitID.lua b/api/PlaySoundKitID.lua new file mode 100644 index 0000000..534dfb3 --- /dev/null +++ b/api/PlaySoundKitID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function PlaySoundKitID() end \ No newline at end of file diff --git a/api/PlayerCanTeleport.lua b/api/PlayerCanTeleport.lua new file mode 100644 index 0000000..7e3c569 --- /dev/null +++ b/api/PlayerCanTeleport.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean amount +---Returns whether the player can accept a summons +function PlayerCanTeleport() end \ No newline at end of file diff --git a/api/PlayerHasHearthstone.lua b/api/PlayerHasHearthstone.lua new file mode 100644 index 0000000..91fd646 --- /dev/null +++ b/api/PlayerHasHearthstone.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean hasHearthstone +---Returns whether the player has a hearthstone in their bag +function PlayerHasHearthstone() end \ No newline at end of file diff --git a/api/PlayerHasToy.lua b/api/PlayerHasToy.lua new file mode 100644 index 0000000..3c1cc04 --- /dev/null +++ b/api/PlayerHasToy.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function PlayerHasToy() end \ No newline at end of file diff --git a/api/PlayerIsPVPInactive.lua b/api/PlayerIsPVPInactive.lua new file mode 100644 index 0000000..9bd64ff --- /dev/null +++ b/api/PlayerIsPVPInactive.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param unit string +---@return boolean isInactive +---Returns whether a battleground participant is inactive (and eligible for reporting as AFK) +function PlayerIsPVPInactive(name, unit) end \ No newline at end of file diff --git a/api/PortGraveyard.lua b/api/PortGraveyard.lua new file mode 100644 index 0000000..7fcb742 --- /dev/null +++ b/api/PortGraveyard.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function PortGraveyard() end \ No newline at end of file diff --git a/api/PreloadMovie.lua b/api/PreloadMovie.lua new file mode 100644 index 0000000..52154dc --- /dev/null +++ b/api/PreloadMovie.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function PreloadMovie() end \ No newline at end of file diff --git a/api/PrevView.lua b/api/PrevView.lua new file mode 100644 index 0000000..012389c --- /dev/null +++ b/api/PrevView.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Moves the camera to the previous predefined setting. There are five "slots" for saved camera settings, indexed 1-5. These views can be set and accessed directly using SaveView() and SetView(), and cycled through using NextView() and PrevView(). +function PrevView() end \ No newline at end of file diff --git a/api/ProcessMapClick.lua b/api/ProcessMapClick.lua new file mode 100644 index 0000000..fa2d71b --- /dev/null +++ b/api/ProcessMapClick.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param clickX number +---@param clickY number +---Possibly changes the WorldMap based on a mouse click. May change the map zone or zoom based on the click location: e.g. if the world map shows Dragonblight and one clicks in the area labeled "Wintergrasp" on the map, the current map zone changes to show Wintergrasp. +function ProcessMapClick(clickX, clickY) end \ No newline at end of file diff --git a/api/ProcessQuestLogRewardFactions.lua b/api/ProcessQuestLogRewardFactions.lua new file mode 100644 index 0000000..1b5af24 --- /dev/null +++ b/api/ProcessQuestLogRewardFactions.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ProcessQuestLogRewardFactions() end \ No newline at end of file diff --git a/api/PromoteToAssistant.lua b/api/PromoteToAssistant.lua new file mode 100644 index 0000000..af8e986 --- /dev/null +++ b/api/PromoteToAssistant.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@param exactMatch boolean +---Promotes a raid member to raid assistant +function PromoteToAssistant(unit, name, exactMatch) end \ No newline at end of file diff --git a/api/PromoteToLeader.lua b/api/PromoteToLeader.lua new file mode 100644 index 0000000..937bdf4 --- /dev/null +++ b/api/PromoteToLeader.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@param exactMatch boolean +---Promotes a player to party/raid leader +function PromoteToLeader(unit, name, exactMatch) end \ No newline at end of file diff --git a/api/PurchaseSlot.lua b/api/PurchaseSlot.lua new file mode 100644 index 0000000..34e7b10 --- /dev/null +++ b/api/PurchaseSlot.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Purchases the next available bank slot. Only available while interacting with a banker NPC (i.e. between the BANKFRAME_OPENED and BANKFRAME_CLOSED events). +function PurchaseSlot() end \ No newline at end of file diff --git a/api/PutItemInBackpack.lua b/api/PutItemInBackpack.lua new file mode 100644 index 0000000..08829e8 --- /dev/null +++ b/api/PutItemInBackpack.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil hadItem +---Puts the item on the cursor into the player's backpack. The item will be placed in the lowest numbered slot (containerSlotID) in the player's backpack. Causes an error message (UI_ERROR_MESSAGE) if the backpack is full. +function PutItemInBackpack() end \ No newline at end of file diff --git a/api/PutItemInBag.lua b/api/PutItemInBag.lua new file mode 100644 index 0000000..0219b93 --- /dev/null +++ b/api/PutItemInBag.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param inventory number +---@return 1nil hadItem +---Puts the item on the cursor into one of the player's bags or other containers. The item will be placed in the lowest numbered slot (containerSlotID) in the container. Causes an error message (UI_ERROR_MESSAGE) if the container is full. Cannot be used to place an item into the player's backpack; see PutItemInBackpack(). +function PutItemInBag(inventory) end \ No newline at end of file diff --git a/api/QueryAuctionItems.lua b/api/QueryAuctionItems.lua new file mode 100644 index 0000000..679d64c --- /dev/null +++ b/api/QueryAuctionItems.lua @@ -0,0 +1,14 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param minLevel number +---@param maxLevel number +---@param invTypeIndex number +---@param classIndex number +---@param subClassIndex number +---@param page number +---@param isUsable boolean +---@param minQuality itemQuality +---@param getAll boolean +---Requests data from the server for the list of auctions meeting given search criteria. If any search criterion is omitted or nil, the search will include all possible values for that criterion. Search queries are throttled, preventing abuse of the server by clients sending too many queries in short succession. Normal queries can be sent once every few seconds; mass queries return all results in the auction house instead of one "page" at a time, and can only be sent once every several minutes. Query results are not returned immediately: the AUCTION_ITEM_LIST_UPDATE event fires once data is available; listing information can then be retrieved using GetAuctionItemInfo() or other Auction APIs. +function QueryAuctionItems(name, minLevel, maxLevel, invTypeIndex, classIndex, subClassIndex, page, isUsable, minQuality, getAll) end \ No newline at end of file diff --git a/api/QueryGuildBankLog.lua b/api/QueryGuildBankLog.lua new file mode 100644 index 0000000..adb8caf --- /dev/null +++ b/api/QueryGuildBankLog.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param tab number +---Requests the item transaction log for a guild bank tab from the server. Fires the GUILDBANKLOG_UPDATE event when transaction log information becomes available. +function QueryGuildBankLog(tab) end \ No newline at end of file diff --git a/api/QueryGuildBankTab.lua b/api/QueryGuildBankTab.lua new file mode 100644 index 0000000..1154d7c --- /dev/null +++ b/api/QueryGuildBankTab.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param tab number +---Requests information about the contents of a guild bank tab from the server. Fires the GUILDBANKBAGSLOTS_CHANGED event when information about the tab's contents becomes available. +function QueryGuildBankTab(tab) end \ No newline at end of file diff --git a/api/QueryGuildBankText.lua b/api/QueryGuildBankText.lua new file mode 100644 index 0000000..adf7838 --- /dev/null +++ b/api/QueryGuildBankText.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param tab number +---Requests guild bank tab info text from the server. The text is not returned immediately; the GUILDBANK_UPDATE_TEXT event fires when text is available for retrieval by the GetGuildBankText() function. +function QueryGuildBankText(tab) end \ No newline at end of file diff --git a/api/QueryGuildEventLog.lua b/api/QueryGuildEventLog.lua new file mode 100644 index 0000000..c0c9001 --- /dev/null +++ b/api/QueryGuildEventLog.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Requests guild event log information from the server. Fires the GUILD_EVENT_LOG_UPDATE event when event log information becomes available. +function QueryGuildEventLog() end \ No newline at end of file diff --git a/api/QueryGuildMembersForRecipe.lua b/api/QueryGuildMembersForRecipe.lua new file mode 100644 index 0000000..e7f0f68 --- /dev/null +++ b/api/QueryGuildMembersForRecipe.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function QueryGuildMembersForRecipe() end \ No newline at end of file diff --git a/api/QueryGuildNews.lua b/api/QueryGuildNews.lua new file mode 100644 index 0000000..9cbc99a --- /dev/null +++ b/api/QueryGuildNews.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function QueryGuildNews() end \ No newline at end of file diff --git a/api/QueryGuildRecipes.lua b/api/QueryGuildRecipes.lua new file mode 100644 index 0000000..8e9b745 --- /dev/null +++ b/api/QueryGuildRecipes.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function QueryGuildRecipes() end \ No newline at end of file diff --git a/api/QueryWorldCountdownTimer.lua b/api/QueryWorldCountdownTimer.lua new file mode 100644 index 0000000..abce1e8 --- /dev/null +++ b/api/QueryWorldCountdownTimer.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function QueryWorldCountdownTimer() end \ No newline at end of file diff --git a/api/QuestChooseRewardError.lua b/api/QuestChooseRewardError.lua new file mode 100644 index 0000000..3a453a0 --- /dev/null +++ b/api/QuestChooseRewardError.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Causes the default UI to display an error message indicating that the player must choose a reward to complete the quest presented by a questgiver. Fires a UI_ERROR_MESSAGE event containing a localized message identified by the global variable ERR_QUEST_MUST_CHOOSE. Choose wisely. +function QuestChooseRewardError() end \ No newline at end of file diff --git a/api/QuestFlagsPVP.lua b/api/QuestFlagsPVP.lua new file mode 100644 index 0000000..fa230e8 --- /dev/null +++ b/api/QuestFlagsPVP.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil questFlag +---Returns whether accepting the offered quest will flag the player for PvP. Only valid when the questgiver UI is showing the accept/decline stage of a quest dialog (between the QUEST_DETAIL and QUEST_FINISHED events); otherwise may return nil or a value from the most recently displayed quest. +function QuestFlagsPVP() end \ No newline at end of file diff --git a/api/QuestGetAutoAccept.lua b/api/QuestGetAutoAccept.lua new file mode 100644 index 0000000..106dd3e --- /dev/null +++ b/api/QuestGetAutoAccept.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function QuestGetAutoAccept() end \ No newline at end of file diff --git a/api/QuestGetAutoLaunched.lua b/api/QuestGetAutoLaunched.lua new file mode 100644 index 0000000..43ee2cd --- /dev/null +++ b/api/QuestGetAutoLaunched.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function QuestGetAutoLaunched() end \ No newline at end of file diff --git a/api/QuestHasPOIInfo.lua b/api/QuestHasPOIInfo.lua new file mode 100644 index 0000000..a9b3dff --- /dev/null +++ b/api/QuestHasPOIInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function QuestHasPOIInfo() end \ No newline at end of file diff --git a/api/QuestIsDaily.lua b/api/QuestIsDaily.lua new file mode 100644 index 0000000..b4f738c --- /dev/null +++ b/api/QuestIsDaily.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function QuestIsDaily() end \ No newline at end of file diff --git a/api/QuestIsFromAreaTrigger.lua b/api/QuestIsFromAreaTrigger.lua new file mode 100644 index 0000000..07d7b8d --- /dev/null +++ b/api/QuestIsFromAreaTrigger.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function QuestIsFromAreaTrigger() end \ No newline at end of file diff --git a/api/QuestIsWeekly.lua b/api/QuestIsWeekly.lua new file mode 100644 index 0000000..465f12f --- /dev/null +++ b/api/QuestIsWeekly.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function QuestIsWeekly() end \ No newline at end of file diff --git a/api/QuestLogPushQuest.lua b/api/QuestLogPushQuest.lua new file mode 100644 index 0000000..28d2340 --- /dev/null +++ b/api/QuestLogPushQuest.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param questIndex number +---Shares a quest with other group members +function QuestLogPushQuest(questIndex) end \ No newline at end of file diff --git a/api/QuestLogShouldShowPortrait.lua b/api/QuestLogShouldShowPortrait.lua new file mode 100644 index 0000000..dda8888 --- /dev/null +++ b/api/QuestLogShouldShowPortrait.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function QuestLogShouldShowPortrait() end \ No newline at end of file diff --git a/api/QuestMapUpdateAllQuests.lua b/api/QuestMapUpdateAllQuests.lua new file mode 100644 index 0000000..4942d53 --- /dev/null +++ b/api/QuestMapUpdateAllQuests.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function QuestMapUpdateAllQuests() end \ No newline at end of file diff --git a/api/QuestPOIGetIconInfo.lua b/api/QuestPOIGetIconInfo.lua new file mode 100644 index 0000000..9f62204 --- /dev/null +++ b/api/QuestPOIGetIconInfo.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param questID number +---@return unknown _ +---@return number posX +---@return number posY +---@return number objective +---Returns information about a QuestPOI icon. Only works if the quest is displayed on the world map. Only returns the nearest of these points if there are more than one. +function QuestPOIGetIconInfo(questID) end \ No newline at end of file diff --git a/api/QuestPOIGetQuestIDByIndex.lua b/api/QuestPOIGetQuestIDByIndex.lua new file mode 100644 index 0000000..5e33b8d --- /dev/null +++ b/api/QuestPOIGetQuestIDByIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function QuestPOIGetQuestIDByIndex() end \ No newline at end of file diff --git a/api/QuestPOIGetQuestIDByVisibleIndex.lua b/api/QuestPOIGetQuestIDByVisibleIndex.lua new file mode 100644 index 0000000..65ee0cb --- /dev/null +++ b/api/QuestPOIGetQuestIDByVisibleIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function QuestPOIGetQuestIDByVisibleIndex() end \ No newline at end of file diff --git a/api/QuestPOIGetSecondaryLocations.lua b/api/QuestPOIGetSecondaryLocations.lua new file mode 100644 index 0000000..cd3f8b1 --- /dev/null +++ b/api/QuestPOIGetSecondaryLocations.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function QuestPOIGetSecondaryLocations() end \ No newline at end of file diff --git a/api/QuestPOIUpdateIcons.lua b/api/QuestPOIUpdateIcons.lua new file mode 100644 index 0000000..43c7c70 --- /dev/null +++ b/api/QuestPOIUpdateIcons.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function QuestPOIUpdateIcons() end \ No newline at end of file diff --git a/api/Quit.lua b/api/Quit.lua new file mode 100644 index 0000000..62c44bd --- /dev/null +++ b/api/Quit.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Attempts to exit the World of Warcraft client. Results vary based on current conditions: If the player is in combat or under other temporary restrictions (e.g. falling), fires the UI_ERROR_MESSAGE event with a message indicating the player cannot log out at the moment. If the player is not in an inn, major city, or other "rest" area (i.e. IsResting() returns nil), fires the PLAYER_QUITING event, causing the default UI to show a countdown, quitting WoW after a period of time if not canceled. If the player is in a "rest" area, quits the game immediately. +function Quit() end \ No newline at end of file diff --git a/api/RaidProfileExists.lua b/api/RaidProfileExists.lua new file mode 100644 index 0000000..d1ad633 --- /dev/null +++ b/api/RaidProfileExists.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function RaidProfileExists() end \ No newline at end of file diff --git a/api/RaidProfileHasUnsavedChanges.lua b/api/RaidProfileHasUnsavedChanges.lua new file mode 100644 index 0000000..642a049 --- /dev/null +++ b/api/RaidProfileHasUnsavedChanges.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function RaidProfileHasUnsavedChanges() end \ No newline at end of file diff --git a/api/RandomRoll.lua b/api/RandomRoll.lua new file mode 100644 index 0000000..471736f --- /dev/null +++ b/api/RandomRoll.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param min number,string +---@param max number,string +---Initiates a public, server-side "dice roll". Used in the default UI to implement the /roll chat command; when called, the server generates a random integer and sends it to the player and all others nearby (or in the same party/raid) via a CHAT_MSG_SYSTEM event. (The server message is formatted according to the global RANDOM_ROLL_RESULT; e.g. "Leeroy rolls 3 (1-100)".) For random number generation that does not involve the server or send visible messages to other clients, see math.random. +function RandomRoll(min, max) end \ No newline at end of file diff --git a/api/ReagentBankButtonIDToInvSlotID.lua b/api/ReagentBankButtonIDToInvSlotID.lua new file mode 100644 index 0000000..ebc0d8a --- /dev/null +++ b/api/ReagentBankButtonIDToInvSlotID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ReagentBankButtonIDToInvSlotID() end \ No newline at end of file diff --git a/api/RefreshLFGList.lua b/api/RefreshLFGList.lua new file mode 100644 index 0000000..7db15d8 --- /dev/null +++ b/api/RefreshLFGList.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function RefreshLFGList() end \ No newline at end of file diff --git a/api/RefreshWorldMap.lua b/api/RefreshWorldMap.lua new file mode 100644 index 0000000..f29b8b8 --- /dev/null +++ b/api/RefreshWorldMap.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function RefreshWorldMap() end \ No newline at end of file diff --git a/api/RegisterAddonMessagePrefix.lua b/api/RegisterAddonMessagePrefix.lua new file mode 100644 index 0000000..167c27f --- /dev/null +++ b/api/RegisterAddonMessagePrefix.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param prefix string +---@return boolean success +---Registers to receive addon messages with a given prefix. In order for an addon to receive messages sent using SendAddOnMessage they must first register to receive messages with a given prefix. There is a soft cap of 64 prefixes on the server side, and a hard cap of 512 prefixes on the client side. Exceeding the soft cap is not recommended, but addon messages can still be received. +function RegisterAddonMessagePrefix(prefix) end \ No newline at end of file diff --git a/api/RegisterCVar.lua b/api/RegisterCVar.lua new file mode 100644 index 0000000..8616d0d --- /dev/null +++ b/api/RegisterCVar.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param cvar string +---@param default string +---Registers a configuration variable to be saved +function RegisterCVar(cvar, default) end \ No newline at end of file diff --git a/api/RejectProposal.lua b/api/RejectProposal.lua new file mode 100644 index 0000000..43d275b --- /dev/null +++ b/api/RejectProposal.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Rejects a LFG dungeon invite. +function RejectProposal() end \ No newline at end of file diff --git a/api/ReloadUI.lua b/api/ReloadUI.lua new file mode 100644 index 0000000..2af9e9a --- /dev/null +++ b/api/ReloadUI.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Reloads the user interface. Saved variables are written to disk, the default UI is reloaded, and all enabled non-LoadOnDemand addons are loaded, including any addons previously disabled which were enabled during the session (see EnableAddOn() et al). +function ReloadUI() end \ No newline at end of file diff --git a/api/RemoveAutoQuestPopUp.lua b/api/RemoveAutoQuestPopUp.lua new file mode 100644 index 0000000..7b1aba2 --- /dev/null +++ b/api/RemoveAutoQuestPopUp.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param questId number +---Remove AutoQuestPopup +function RemoveAutoQuestPopUp(questId) end \ No newline at end of file diff --git a/api/RemoveChatWindowChannel.lua b/api/RemoveChatWindowChannel.lua new file mode 100644 index 0000000..3dc1139 --- /dev/null +++ b/api/RemoveChatWindowChannel.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param channel string +---Removes a channel from a chat window's list of saved channel subscriptions. Used by the default UI's function ChatFrame_RemoveChannel() which manages the set of channel messages shown in a displayed ChatFrame. +function RemoveChatWindowChannel(index, channel) end \ No newline at end of file diff --git a/api/RemoveChatWindowMessages.lua b/api/RemoveChatWindowMessages.lua new file mode 100644 index 0000000..87a7771 --- /dev/null +++ b/api/RemoveChatWindowMessages.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param messageGroup string +---Removes a message type from a chat window's list of saved message subscriptions. Used by the default UI's functions ChatFrame_RemoveMessageGroup() and ChatFrame_RemoveAllMessageGroups() which manage the set of message types shown in a displayed ChatFrame. +function RemoveChatWindowMessages(index, messageGroup) end \ No newline at end of file diff --git a/api/RemoveFriend.lua b/api/RemoveFriend.lua new file mode 100644 index 0000000..ddc0197 --- /dev/null +++ b/api/RemoveFriend.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---Removes a character from the friends list +function RemoveFriend(name) end \ No newline at end of file diff --git a/api/RemoveGlyphFromSocket.lua b/api/RemoveGlyphFromSocket.lua new file mode 100644 index 0000000..d3cfe9c --- /dev/null +++ b/api/RemoveGlyphFromSocket.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param socket number +---Removes the glyph from a socket +function RemoveGlyphFromSocket(socket) end \ No newline at end of file diff --git a/api/RemoveItemFromArtifact.lua b/api/RemoveItemFromArtifact.lua new file mode 100644 index 0000000..f60fe11 --- /dev/null +++ b/api/RemoveItemFromArtifact.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function RemoveItemFromArtifact() end \ No newline at end of file diff --git a/api/RemoveQuestWatch.lua b/api/RemoveQuestWatch.lua new file mode 100644 index 0000000..94f73e1 --- /dev/null +++ b/api/RemoveQuestWatch.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param questIndex number +---Removes a quest from the objectives tracker +function RemoveQuestWatch(questIndex) end \ No newline at end of file diff --git a/api/RemoveTalent.lua b/api/RemoveTalent.lua new file mode 100644 index 0000000..6c45f52 --- /dev/null +++ b/api/RemoveTalent.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function RemoveTalent() end \ No newline at end of file diff --git a/api/RemoveTrackedAchievement.lua b/api/RemoveTrackedAchievement.lua new file mode 100644 index 0000000..878c013 --- /dev/null +++ b/api/RemoveTrackedAchievement.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---Removes an achievement from the objectives tracker UI +function RemoveTrackedAchievement(id) end \ No newline at end of file diff --git a/api/RenamePetition.lua b/api/RenamePetition.lua new file mode 100644 index 0000000..4f5fba9 --- /dev/null +++ b/api/RenamePetition.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---Renames the guild or arena team to be created by the open petition +function RenamePetition(name) end \ No newline at end of file diff --git a/api/RepairAllItems.lua b/api/RepairAllItems.lua new file mode 100644 index 0000000..af50d53 --- /dev/null +++ b/api/RepairAllItems.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param useGuildMoney 1nil +---Attempts to repair all of the player's damaged items +function RepairAllItems(useGuildMoney) end \ No newline at end of file diff --git a/api/ReplaceEnchant.lua b/api/ReplaceEnchant.lua new file mode 100644 index 0000000..b640229 --- /dev/null +++ b/api/ReplaceEnchant.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Confirms replacing an existing enchantment. Usable in response to the REPLACE_ENCHANT event which fires when the player attempts to apply a temporary or permanent enchantment to an item which already has one. +function ReplaceEnchant() end \ No newline at end of file diff --git a/api/ReplaceGuildMaster.lua b/api/ReplaceGuildMaster.lua new file mode 100644 index 0000000..9a70c50 --- /dev/null +++ b/api/ReplaceGuildMaster.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ReplaceGuildMaster() end \ No newline at end of file diff --git a/api/ReplaceTradeEnchant.lua b/api/ReplaceTradeEnchant.lua new file mode 100644 index 0000000..cea37d0 --- /dev/null +++ b/api/ReplaceTradeEnchant.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Confirms replacement of an existing enchantment when offering an enchantment for trade. After confirming, the enchantment is not actually performed until both parties accept the trade. +function ReplaceTradeEnchant() end \ No newline at end of file diff --git a/api/RepopMe.lua b/api/RepopMe.lua new file mode 100644 index 0000000..9fdb40c --- /dev/null +++ b/api/RepopMe.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Releases the player's spirit to the nearest graveyard. Only has effect if the player is dead. +function RepopMe() end \ No newline at end of file diff --git a/api/ReportBug.lua b/api/ReportBug.lua new file mode 100644 index 0000000..763825a --- /dev/null +++ b/api/ReportBug.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ReportBug() end \ No newline at end of file diff --git a/api/ReportPlayer.lua b/api/ReportPlayer.lua new file mode 100644 index 0000000..3b85c03 --- /dev/null +++ b/api/ReportPlayer.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param reportType string +---@param lineID number +---@param pending string +---@param comment +---Report a player to a GM. +function ReportPlayer(reportType, lineID, pending, comment) end \ No newline at end of file diff --git a/api/ReportPlayerIsPVPAFK.lua b/api/ReportPlayerIsPVPAFK.lua new file mode 100644 index 0000000..d0005e3 --- /dev/null +++ b/api/ReportPlayerIsPVPAFK.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param unit string +---Reports a battleground participant as AFK +function ReportPlayerIsPVPAFK(name, unit) end \ No newline at end of file diff --git a/api/ReportSuggestion.lua b/api/ReportSuggestion.lua new file mode 100644 index 0000000..bfb5e15 --- /dev/null +++ b/api/ReportSuggestion.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ReportSuggestion() end \ No newline at end of file diff --git a/api/RequestArtifactCompletionHistory.lua b/api/RequestArtifactCompletionHistory.lua new file mode 100644 index 0000000..9e7d10f --- /dev/null +++ b/api/RequestArtifactCompletionHistory.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Queries the server for the player's artifact completion history. This function will return immediately, and the ARTIFACT_HISTORY_READY will fire when the information is available from the server. +function RequestArtifactCompletionHistory() end \ No newline at end of file diff --git a/api/RequestBattlefieldScoreData.lua b/api/RequestBattlefieldScoreData.lua new file mode 100644 index 0000000..cbcdf8d --- /dev/null +++ b/api/RequestBattlefieldScoreData.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Requests battlefield score data from the server. Score data is not returned immediately; the UPDATE_BATTLEFIELD_SCORE event fires once information is available and can be retrieved by calling GetBattlefieldScore() and related functions. +function RequestBattlefieldScoreData() end \ No newline at end of file diff --git a/api/RequestBattlegroundInstanceInfo.lua b/api/RequestBattlegroundInstanceInfo.lua new file mode 100644 index 0000000..9ea1ca9 --- /dev/null +++ b/api/RequestBattlegroundInstanceInfo.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Requests information about available instances of a battleground from the server. The PVPQUEUE_ANYWHERE_SHOW event fires once information is available; data can then be retrieved by calling GetNumBattlefields() and GetBattlefieldInstanceInfo(). +function RequestBattlegroundInstanceInfo(index) end \ No newline at end of file diff --git a/api/RequestChallengeModeLeaders.lua b/api/RequestChallengeModeLeaders.lua new file mode 100644 index 0000000..28192f8 --- /dev/null +++ b/api/RequestChallengeModeLeaders.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function RequestChallengeModeLeaders() end \ No newline at end of file diff --git a/api/RequestChallengeModeMapInfo.lua b/api/RequestChallengeModeMapInfo.lua new file mode 100644 index 0000000..e2210bf --- /dev/null +++ b/api/RequestChallengeModeMapInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function RequestChallengeModeMapInfo() end \ No newline at end of file diff --git a/api/RequestChallengeModeRewards.lua b/api/RequestChallengeModeRewards.lua new file mode 100644 index 0000000..d45c38a --- /dev/null +++ b/api/RequestChallengeModeRewards.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function RequestChallengeModeRewards() end \ No newline at end of file diff --git a/api/RequestGuildApplicantsList.lua b/api/RequestGuildApplicantsList.lua new file mode 100644 index 0000000..74af51b --- /dev/null +++ b/api/RequestGuildApplicantsList.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function RequestGuildApplicantsList() end \ No newline at end of file diff --git a/api/RequestGuildChallengeInfo.lua b/api/RequestGuildChallengeInfo.lua new file mode 100644 index 0000000..521cd0e --- /dev/null +++ b/api/RequestGuildChallengeInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function RequestGuildChallengeInfo() end \ No newline at end of file diff --git a/api/RequestGuildMembership.lua b/api/RequestGuildMembership.lua new file mode 100644 index 0000000..abc861b --- /dev/null +++ b/api/RequestGuildMembership.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function RequestGuildMembership() end \ No newline at end of file diff --git a/api/RequestGuildMembershipList.lua b/api/RequestGuildMembershipList.lua new file mode 100644 index 0000000..1f84faa --- /dev/null +++ b/api/RequestGuildMembershipList.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function RequestGuildMembershipList() end \ No newline at end of file diff --git a/api/RequestGuildPartyState.lua b/api/RequestGuildPartyState.lua new file mode 100644 index 0000000..223336a --- /dev/null +++ b/api/RequestGuildPartyState.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function RequestGuildPartyState() end \ No newline at end of file diff --git a/api/RequestGuildRecruitmentSettings.lua b/api/RequestGuildRecruitmentSettings.lua new file mode 100644 index 0000000..2474a41 --- /dev/null +++ b/api/RequestGuildRecruitmentSettings.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function RequestGuildRecruitmentSettings() end \ No newline at end of file diff --git a/api/RequestGuildRewards.lua b/api/RequestGuildRewards.lua new file mode 100644 index 0000000..cb63ce7 --- /dev/null +++ b/api/RequestGuildRewards.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function RequestGuildRewards() end \ No newline at end of file diff --git a/api/RequestInspectHonorData.lua b/api/RequestInspectHonorData.lua new file mode 100644 index 0000000..f97307a --- /dev/null +++ b/api/RequestInspectHonorData.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Requests PvP honor and arena data from the server for the currently inspected unit. Once the INSPECT_HONOR_UPDATE event fires, PvP honor and arena information can be retrieved using GetInspectHonorData(team) and GetInspectArenaTeamData(). +function RequestInspectHonorData() end \ No newline at end of file diff --git a/api/RequestLFDPartyLockInfo.lua b/api/RequestLFDPartyLockInfo.lua new file mode 100644 index 0000000..7a7ce66 --- /dev/null +++ b/api/RequestLFDPartyLockInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function RequestLFDPartyLockInfo() end \ No newline at end of file diff --git a/api/RequestLFDPlayerLockInfo.lua b/api/RequestLFDPlayerLockInfo.lua new file mode 100644 index 0000000..dbe8c46 --- /dev/null +++ b/api/RequestLFDPlayerLockInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Requests instance lockout and Call to Arms dungeon reward information.. When called the server will update the client on instance lockout and Call to Arms. The API will then return updated values instead of old once. Once LFG_UPDATE_RANDOM_INFO event is received it means that updated Call to Arms data is finally available for the client. +function RequestLFDPlayerLockInfo() end \ No newline at end of file diff --git a/api/RequestPVPOptionsEnabled.lua b/api/RequestPVPOptionsEnabled.lua new file mode 100644 index 0000000..ad2f0ec --- /dev/null +++ b/api/RequestPVPOptionsEnabled.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function RequestPVPOptionsEnabled() end \ No newline at end of file diff --git a/api/RequestPVPRewards.lua b/api/RequestPVPRewards.lua new file mode 100644 index 0000000..4224671 --- /dev/null +++ b/api/RequestPVPRewards.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Requests informations about Conquest Point cap from the server. The text is not returned immediately; the PVP_REWARDS_UPDATE event fires when text is available for retrieval by the GetPVPRewards() function. +function RequestPVPRewards() end \ No newline at end of file diff --git a/api/RequestRaidInfo.lua b/api/RequestRaidInfo.lua new file mode 100644 index 0000000..706435d --- /dev/null +++ b/api/RequestRaidInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Requests information about saved instances from the server. Data is not returned immediately; the UPDATE_INSTANCE_INFO event when the raid information is available for retrieval via GetSavedInstanceInfo() and related functions. +function RequestRaidInfo() end \ No newline at end of file diff --git a/api/RequestRandomBattlegroundInstanceInfo.lua b/api/RequestRandomBattlegroundInstanceInfo.lua new file mode 100644 index 0000000..1c2f830 --- /dev/null +++ b/api/RequestRandomBattlegroundInstanceInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function RequestRandomBattlegroundInstanceInfo() end \ No newline at end of file diff --git a/api/RequestRatedInfo.lua b/api/RequestRatedInfo.lua new file mode 100644 index 0000000..aaa80f2 --- /dev/null +++ b/api/RequestRatedInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function RequestRatedInfo() end \ No newline at end of file diff --git a/api/RequestRecruitingGuildsList.lua b/api/RequestRecruitingGuildsList.lua new file mode 100644 index 0000000..c8ec51a --- /dev/null +++ b/api/RequestRecruitingGuildsList.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function RequestRecruitingGuildsList() end \ No newline at end of file diff --git a/api/RequestTimePlayed.lua b/api/RequestTimePlayed.lua new file mode 100644 index 0000000..edd0dda --- /dev/null +++ b/api/RequestTimePlayed.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Requests information from the server about the player character's total time spent online. Information is not returned immediately; the TIME_PLAYED_MSG event fires when the requested data is available. +function RequestTimePlayed() end \ No newline at end of file diff --git a/api/RequeueSkirmish.lua b/api/RequeueSkirmish.lua new file mode 100644 index 0000000..33ad4f9 --- /dev/null +++ b/api/RequeueSkirmish.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function RequeueSkirmish() end \ No newline at end of file diff --git a/api/ResetAddOns.lua b/api/ResetAddOns.lua new file mode 100644 index 0000000..9614f56 --- /dev/null +++ b/api/ResetAddOns.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ResetAddOns() end \ No newline at end of file diff --git a/api/ResetCPUUsage.lua b/api/ResetCPUUsage.lua new file mode 100644 index 0000000..841a704 --- /dev/null +++ b/api/ResetCPUUsage.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Resets CPU usage statistics. Only has effect if the scriptProfile CVar is set to 1. +function ResetCPUUsage() end \ No newline at end of file diff --git a/api/ResetChallengeMode.lua b/api/ResetChallengeMode.lua new file mode 100644 index 0000000..e42f528 --- /dev/null +++ b/api/ResetChallengeMode.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ResetChallengeMode() end \ No newline at end of file diff --git a/api/ResetChatColors.lua b/api/ResetChatColors.lua new file mode 100644 index 0000000..e285f74 --- /dev/null +++ b/api/ResetChatColors.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Removes all saved color settings for chat message types, resetting them to default values +function ResetChatColors() end \ No newline at end of file diff --git a/api/ResetChatWindows.lua b/api/ResetChatWindows.lua new file mode 100644 index 0000000..6c85417 --- /dev/null +++ b/api/ResetChatWindows.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Removes all saved chat window settings, resetting them to default values. Used by the default UI's function FCF_ ResetChatWindows() which resets the appearance and behavior of displayed FloatingChatFrames. +function ResetChatWindows() end \ No newline at end of file diff --git a/api/ResetCursor.lua b/api/ResetCursor.lua new file mode 100644 index 0000000..1b14427 --- /dev/null +++ b/api/ResetCursor.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Returns the cursor to its normal appearance (the glove pointer) and behavior. Has effect after the cursor image/mode has been changed via SetCursor(), ShowContainerSellCursor(), or similar. Has no immediately visible effect if the cursor is holding an item, spell, or other data. +function ResetCursor() end \ No newline at end of file diff --git a/api/ResetDisabledAddOns.lua b/api/ResetDisabledAddOns.lua new file mode 100644 index 0000000..8ccb61a --- /dev/null +++ b/api/ResetDisabledAddOns.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Reverts changes to the enabled/disabled state of addons. Any addons enabled or disabled in the current session will return to their enabled/disabled state as of the last login or UI reload. +function ResetDisabledAddOns() end \ No newline at end of file diff --git a/api/ResetInstances.lua b/api/ResetInstances.lua new file mode 100644 index 0000000..1476b2d --- /dev/null +++ b/api/ResetInstances.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Resets all non-saved instances associated with the player. Only instances to which the player is not saved may be reset (i.e. normal 5-man dungeons, not heroic dungeons or raids), and only by a solo player or group leader. +function ResetInstances() end \ No newline at end of file diff --git a/api/ResetPerformanceValues.lua b/api/ResetPerformanceValues.lua new file mode 100644 index 0000000..8e83cee --- /dev/null +++ b/api/ResetPerformanceValues.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ResetPerformanceValues() end \ No newline at end of file diff --git a/api/ResetSetMerchantFilter.lua b/api/ResetSetMerchantFilter.lua new file mode 100644 index 0000000..6700b44 --- /dev/null +++ b/api/ResetSetMerchantFilter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Changes the filter applied to the merchant back to its default. The default filter is always "Class - All Specilizations" This is filter index 1 for use in GetMerchantFilter() and SetMerchantFilter() +function ResetSetMerchantFilter() end \ No newline at end of file diff --git a/api/ResetTutorials.lua b/api/ResetTutorials.lua new file mode 100644 index 0000000..ba48926 --- /dev/null +++ b/api/ResetTutorials.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Enables contextual tutorial display and clears the list of already displayed tutorials. Tutorials that have already been shown to the player will appear again (via TUTORIAL_TRIGGER events) once their conditions are met. The first tutorial will appear again immediately. +function ResetTutorials() end \ No newline at end of file diff --git a/api/ResetView.lua b/api/ResetView.lua new file mode 100644 index 0000000..eb91a93 --- /dev/null +++ b/api/ResetView.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Resets a saved camera setting to default values. There are five "slots" for saved camera settings, indexed 1-5. These views can be set and accessed directly using SaveView() and SetView(), and cycled through using NextView() and PrevView(). +function ResetView(index) end \ No newline at end of file diff --git a/api/ResistancePercent.lua b/api/ResistancePercent.lua new file mode 100644 index 0000000..44714e0 --- /dev/null +++ b/api/ResistancePercent.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param ResistanceValue number +---@param CasterLevel number +---@return number resistancePercent +---Returns the % value of spell resistance depending on resistance value and player level +function ResistancePercent(ResistanceValue, CasterLevel) end \ No newline at end of file diff --git a/api/RespondInstanceLock.lua b/api/RespondInstanceLock.lua new file mode 100644 index 0000000..03d8aff --- /dev/null +++ b/api/RespondInstanceLock.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param response true +---@param false +---@param true +---Allows leaving a recently entered instance to which the player would otherwise be saved.   Applies when the player enters an instance to which other members of her group are saved; if the player leaves the within the time limit (see GetInstanceLockTimeRemaining()) she will not be saved to the instance. +function RespondInstanceLock(response, false, true) end \ No newline at end of file diff --git a/api/RespondMailLockSendItem.lua b/api/RespondMailLockSendItem.lua new file mode 100644 index 0000000..fb7da30 --- /dev/null +++ b/api/RespondMailLockSendItem.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function RespondMailLockSendItem() end \ No newline at end of file diff --git a/api/RestartGx.lua b/api/RestartGx.lua new file mode 100644 index 0000000..06b5011 --- /dev/null +++ b/api/RestartGx.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Restart the client's graphic subsystem. Does not reload the UI. +function RestartGx() end \ No newline at end of file diff --git a/api/RestoreRaidProfileFromCopy.lua b/api/RestoreRaidProfileFromCopy.lua new file mode 100644 index 0000000..ac1cd56 --- /dev/null +++ b/api/RestoreRaidProfileFromCopy.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function RestoreRaidProfileFromCopy() end \ No newline at end of file diff --git a/api/ResurrectGetOfferer.lua b/api/ResurrectGetOfferer.lua new file mode 100644 index 0000000..a8916bc --- /dev/null +++ b/api/ResurrectGetOfferer.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return string name +---Returns the name of a unit offering to resurrect the player. Returns nil if no resurrection has been offered or if an offer has expired. +function ResurrectGetOfferer() end \ No newline at end of file diff --git a/api/ResurrectHasSickness.lua b/api/ResurrectHasSickness.lua new file mode 100644 index 0000000..295c90a --- /dev/null +++ b/api/ResurrectHasSickness.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil hasSickness +---Returns whether accepting an offered resurrection spell will cause the player to suffer Resurrection Sickness. Usable following the RESURRECT_REQUEST event which fires when the player is offered resurrection by another unit. Generally always returns nil, as resurrection by other players does not cause sickness. +function ResurrectHasSickness() end \ No newline at end of file diff --git a/api/ResurrectHasTimer.lua b/api/ResurrectHasTimer.lua new file mode 100644 index 0000000..eaa4dc0 --- /dev/null +++ b/api/ResurrectHasTimer.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil hasTimer +---Returns whether the player must wait before resurrecting. Applies to resurrection spells offered by other units, resurrecting by returning to the player's corpse as a ghost, and to resurrecting at a graveyard's spirit healer, if the player has recently died several times in short succession. See GetCorpseRecoveryDelay() for the time remaining until the player can resurrect. +function ResurrectHasTimer() end \ No newline at end of file diff --git a/api/RetrieveCorpse.lua b/api/RetrieveCorpse.lua new file mode 100644 index 0000000..e75ad04 --- /dev/null +++ b/api/RetrieveCorpse.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Confirms resurrection by returning to the player's corpse +function RetrieveCorpse() end \ No newline at end of file diff --git a/api/ReturnInboxItem.lua b/api/ReturnInboxItem.lua new file mode 100644 index 0000000..9e09b73 --- /dev/null +++ b/api/ReturnInboxItem.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param mailID number +---Returns a message in the player's inbox to its sender +function ReturnInboxItem(mailID) end \ No newline at end of file diff --git a/api/RollOnLoot.lua b/api/RollOnLoot.lua new file mode 100644 index 0000000..1ad145a --- /dev/null +++ b/api/RollOnLoot.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---@param rollType 3 +---@param 0 +---@param 1 +---@param 2 +---@param 3 +---Register the player's intent regarding an item up for loot rolling. Rolls are not actually performed until all eligible group members have registered their intent or the time period for rolling expires. If the item binds on pickup, the CONFIRM_LOOT_ROLL event fires, indicating that ConfirmLootRoll(id) must be called in order to actually roll on the item. +function RollOnLoot(id, rollType, 0, 1, 2, 3) end \ No newline at end of file diff --git a/api/RunBinding.lua b/api/RunBinding.lua new file mode 100644 index 0000000..c4b78f8 --- /dev/null +++ b/api/RunBinding.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param COMMAND string +---Runs the script associated with a key binding action. Note: this function is not protected, but the scripts for many default key binding actions are (and can only be called by the Blizzard UI). +function RunBinding(COMMAND) end \ No newline at end of file diff --git a/api/RunMacro.lua b/api/RunMacro.lua new file mode 100644 index 0000000..0088e85 --- /dev/null +++ b/api/RunMacro.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param name string +---@param "button" string +---Runs a macro +function RunMacro(index, name, "button") end \ No newline at end of file diff --git a/api/RunMacroText.lua b/api/RunMacroText.lua new file mode 100644 index 0000000..df7c4aa --- /dev/null +++ b/api/RunMacroText.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param "text" string +---@param "button" string +---Runs arbitrary text as a macro +function RunMacroText("text", "button") end \ No newline at end of file diff --git a/api/RunScript.lua b/api/RunScript.lua new file mode 100644 index 0000000..5ec0512 --- /dev/null +++ b/api/RunScript.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param script string +---Runs a string as a Lua script +function RunScript(script) end \ No newline at end of file diff --git a/api/SaveAddOns.lua b/api/SaveAddOns.lua new file mode 100644 index 0000000..5bc61fa --- /dev/null +++ b/api/SaveAddOns.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SaveAddOns() end \ No newline at end of file diff --git a/api/SaveBindings.lua b/api/SaveBindings.lua new file mode 100644 index 0000000..c95558b --- /dev/null +++ b/api/SaveBindings.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param set 2 +---@param 1 +---@param 2 +---Saves the current set of key bindings +function SaveBindings(set, 1, 2) end \ No newline at end of file diff --git a/api/SaveEquipmentSet.lua b/api/SaveEquipmentSet.lua new file mode 100644 index 0000000..559ff5f --- /dev/null +++ b/api/SaveEquipmentSet.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param icon number +---Saves or creates an equipment set with the player's currently equipped items. If a set with the same name already exists, that set's contents are overwritten. Set names are case sensitive: if a "Fishing" set already exists, saving a "fishing" set will create a new set instead of overwriting the "Fishing" set. +function SaveEquipmentSet(name, icon) end \ No newline at end of file diff --git a/api/SaveRaidProfileCopy.lua b/api/SaveRaidProfileCopy.lua new file mode 100644 index 0000000..7340733 --- /dev/null +++ b/api/SaveRaidProfileCopy.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SaveRaidProfileCopy() end \ No newline at end of file diff --git a/api/SaveView.lua b/api/SaveView.lua new file mode 100644 index 0000000..3f08168 --- /dev/null +++ b/api/SaveView.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Saves the current camera settings. There are five "slots" for saved camera settings, indexed 1-5. These views can be set and accessed directly using SaveView() and SetView(), and cycled through using NextView() and PrevView(). +function SaveView(index) end \ No newline at end of file diff --git a/api/Screenshot.lua b/api/Screenshot.lua new file mode 100644 index 0000000..b2a8400 --- /dev/null +++ b/api/Screenshot.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Saves an image of the current game display. Screenshot images are saved to the folder Screenshots within the folder where the World of Warcraft client is installed. Taking a screenshot fires the SCREENSHOT_SUCCEEDED event (or the SCREENSHOT_FAILED event in case of an error), which causes the default UI to display a message in the middle of the screen. Additional screenshots taken while this message is displayed will include it -- the default UI's TakeScreenshot() function hides this message so it is not included in screenshots. +function Screenshot() end \ No newline at end of file diff --git a/api/SearchGuildRecipes.lua b/api/SearchGuildRecipes.lua new file mode 100644 index 0000000..b23210a --- /dev/null +++ b/api/SearchGuildRecipes.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SearchGuildRecipes() end \ No newline at end of file diff --git a/api/SearchLFGGetEncounterResults.lua b/api/SearchLFGGetEncounterResults.lua new file mode 100644 index 0000000..b948db2 --- /dev/null +++ b/api/SearchLFGGetEncounterResults.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SearchLFGGetEncounterResults() end \ No newline at end of file diff --git a/api/SearchLFGGetJoinedID.lua b/api/SearchLFGGetJoinedID.lua new file mode 100644 index 0000000..ec09ae0 --- /dev/null +++ b/api/SearchLFGGetJoinedID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SearchLFGGetJoinedID() end \ No newline at end of file diff --git a/api/SearchLFGGetNumResults.lua b/api/SearchLFGGetNumResults.lua new file mode 100644 index 0000000..74de405 --- /dev/null +++ b/api/SearchLFGGetNumResults.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SearchLFGGetNumResults() end \ No newline at end of file diff --git a/api/SearchLFGGetPartyResults.lua b/api/SearchLFGGetPartyResults.lua new file mode 100644 index 0000000..636a714 --- /dev/null +++ b/api/SearchLFGGetPartyResults.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SearchLFGGetPartyResults() end \ No newline at end of file diff --git a/api/SearchLFGGetResults.lua b/api/SearchLFGGetResults.lua new file mode 100644 index 0000000..bfb4ba8 --- /dev/null +++ b/api/SearchLFGGetResults.lua @@ -0,0 +1,20 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index +---@return name +---@return level +---@return areaName +---@return className +---@return comment +---@return partyMembers +---@return status +---@return class +---@return encountersTotal +---@return encountersComplete +---@return isIneligible +---@return isLeader +---@return isTank +---@return isHealer +---@return isDamage +---Returns information about the players progress in the raidfinder.. Seems to be deprecated :( Could not find any valued arguments, also the part in FrameXML where I found it seems to be unused. Try GetRFDungeonInfo instead. +function SearchLFGGetResults(index) end \ No newline at end of file diff --git a/api/SearchLFGJoin.lua b/api/SearchLFGJoin.lua new file mode 100644 index 0000000..6a1408e --- /dev/null +++ b/api/SearchLFGJoin.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SearchLFGJoin() end \ No newline at end of file diff --git a/api/SearchLFGLeave.lua b/api/SearchLFGLeave.lua new file mode 100644 index 0000000..4ff9af4 --- /dev/null +++ b/api/SearchLFGLeave.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SearchLFGLeave() end \ No newline at end of file diff --git a/api/SearchLFGSort.lua b/api/SearchLFGSort.lua new file mode 100644 index 0000000..56d8a2f --- /dev/null +++ b/api/SearchLFGSort.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SearchLFGSort() end \ No newline at end of file diff --git a/api/SecondsToTime.lua b/api/SecondsToTime.lua new file mode 100644 index 0000000..d7374c8 --- /dev/null +++ b/api/SecondsToTime.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param seconds number +---@param noSeconds boolean +---@param notAbbreviated boolean +---@param maxCount number +---@return string time +---Returns a description of an amount of time in appropriate units. Output includes markup normally hidden when displayed in a FontString (see last example); this markup allows the client to automatically print the singular or plural form of a word depending on the value of the preceding number. +function SecondsToTime(seconds, noSeconds, notAbbreviated, maxCount) end \ No newline at end of file diff --git a/api/SecureCmdOptionParse.lua b/api/SecureCmdOptionParse.lua new file mode 100644 index 0000000..84f1c2d --- /dev/null +++ b/api/SecureCmdOptionParse.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param cmd string +---@return string action +---@return string target +---Returns the action (and target, if applicable) for a secure macro command. Used in the default UI to parse macro conditionals. +function SecureCmdOptionParse(cmd) end \ No newline at end of file diff --git a/api/SelectActiveQuest.lua b/api/SelectActiveQuest.lua new file mode 100644 index 0000000..9b966fa --- /dev/null +++ b/api/SelectActiveQuest.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Selects a quest which can be turned in to the current Quest NPC. Usable after a QUEST_GREETING event. Causes the QUEST_PROGRESS event to fire, in which it is determined whether the player can complete the quest. Note: Most quest NPCs present active quests using the GetGossipActiveQuests() instead of this function. +function SelectActiveQuest(index) end \ No newline at end of file diff --git a/api/SelectAvailableQuest.lua b/api/SelectAvailableQuest.lua new file mode 100644 index 0000000..67d2f34 --- /dev/null +++ b/api/SelectAvailableQuest.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Chooses a quest available from the current Quest NPC. Causes the QUEST_DETAIL event to fire, in which the questgiver presents the player with the details of a quest and the option to accept or decline. Note: Most quest NPCs present available quests using the GetGossipAvailableQuests() instead of this function. +function SelectAvailableQuest(index) end \ No newline at end of file diff --git a/api/SelectGossipActiveQuest.lua b/api/SelectGossipActiveQuest.lua new file mode 100644 index 0000000..9a1aac5 --- /dev/null +++ b/api/SelectGossipActiveQuest.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Chooses a quest which can be turned in to the current Gossip NPC. Causes the QUEST_PROGRESS event to fire, in which it is determined whether the player can complete the quest. +function SelectGossipActiveQuest(index) end \ No newline at end of file diff --git a/api/SelectGossipAvailableQuest.lua b/api/SelectGossipAvailableQuest.lua new file mode 100644 index 0000000..98b5ea0 --- /dev/null +++ b/api/SelectGossipAvailableQuest.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Chooses a quest available from the current Gossip NPC. Usable after a QUEST_GREETING event. Causes the QUEST_DETAIL event to fire, in which the questgiver presents the player with the details of a quest and the option to accept or decline. +function SelectGossipAvailableQuest(index) end \ No newline at end of file diff --git a/api/SelectGossipOption.lua b/api/SelectGossipOption.lua new file mode 100644 index 0000000..b11b394 --- /dev/null +++ b/api/SelectGossipOption.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param text string +---@param confirm boolean +---Chooses and activates an NPC dialog option. Results may vary according to the gossip option chosen; may end the gossip (firing a GOSSIP_CLOSED event) and start another interaction (firing a MERCHANT_SHOW, TRAINER_SHOW, TAXIMAP_OPENED, or similar event) or may continue the gossip with new text and new options (firing another GOSSIP_SHOW event). Calling this function with only the first argument may cause the GOSSIP_CONFIRM event to fire, indicating that the player needs to provide confirmation (or additional information) before the option will be activated. Confirmation is needed for certain options requiring the character to spend (e.g. when activating Dual Talent Specialization); additional information is needed for options such as those used when redeeming a Loot Card code from the WoW trading card game to receive an in-game item. In either case, the confirmation and additional information can be provided (as by the popup dialog in the default UI) by calling this function again with all three arguments. +function SelectGossipOption(index, text, confirm) end \ No newline at end of file diff --git a/api/SelectPackage.lua b/api/SelectPackage.lua new file mode 100644 index 0000000..47dbe7b --- /dev/null +++ b/api/SelectPackage.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SelectPackage() end \ No newline at end of file diff --git a/api/SelectQuestLogEntry.lua b/api/SelectQuestLogEntry.lua new file mode 100644 index 0000000..d076533 --- /dev/null +++ b/api/SelectQuestLogEntry.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param questIndex number +---Selects a quest from the quest log. The selected quest is used by other functions which do not take a quest index as argument (e.g. GetQuestLogQuestText()). +function SelectQuestLogEntry(questIndex) end \ No newline at end of file diff --git a/api/SelectStationery.lua b/api/SelectStationery.lua new file mode 100644 index 0000000..3883c08 --- /dev/null +++ b/api/SelectStationery.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Selects a given stationery for usage when sending mail. Has no effect; the stationery feature for sending mail is not implemented in the current version of World of Warcraft. +function SelectStationery(index) end \ No newline at end of file diff --git a/api/SelectTradeSkill.lua b/api/SelectTradeSkill.lua new file mode 100644 index 0000000..7384ce5 --- /dev/null +++ b/api/SelectTradeSkill.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Selects a recipe in the trade skill listing. Selection in the recipe list is used only for display in the default UI and has no effect on other Trade Skill APIs. +function SelectTradeSkill(index) end \ No newline at end of file diff --git a/api/SelectTrainerService.lua b/api/SelectTrainerService.lua new file mode 100644 index 0000000..74289f7 --- /dev/null +++ b/api/SelectTrainerService.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Selects an entry in the trainer service listing. Selection in the service list is used only for display in the default UI and has no effect on other Trainer APIs. +function SelectTrainerService(index) end \ No newline at end of file diff --git a/api/SelectedRealmName.lua b/api/SelectedRealmName.lua new file mode 100644 index 0000000..fb97194 --- /dev/null +++ b/api/SelectedRealmName.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SelectedRealmName() end \ No newline at end of file diff --git a/api/SendAddonMessage.lua b/api/SendAddonMessage.lua new file mode 100644 index 0000000..7beda41 --- /dev/null +++ b/api/SendAddonMessage.lua @@ -0,0 +1,15 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param prefix string +---@param message string +---@param type WHISPER +---@param BATTLEGROUND +---@param CHANNEL +---@param GUILD +---@param OFFICER +---@param PARTY +---@param RAID +---@param WHISPER +---@param target string +---Sends a chat-like message receivable by other addons. Allows for client-to-client addon communication. Unlike with SendChatMessage, messages sent via SendAddonMessage: do not appear in receiving players' chat windows (unless an addon explicitly prints them) are not subject to strict server-side spam filtering/throttling (sending too many messages at once can still disconnect the user) are not modified if the sending character is drunk Messages are received via the CHAT_MSG_ADDON event. The client utilizes the prefix string to filter messages; only those prefixes which have been registered will be received. Prefixes can be registered using RegisterAddonMessagePrefix. There is currently no support for sending addon messages to Real ID or BattleTag friends. +function SendAddonMessage(prefix, message, type, BATTLEGROUND, CHANNEL, GUILD, OFFICER, PARTY, RAID, WHISPER, target) end \ No newline at end of file diff --git a/api/SendChatMessage.lua b/api/SendChatMessage.lua new file mode 100644 index 0000000..05fde41 --- /dev/null +++ b/api/SendChatMessage.lua @@ -0,0 +1,20 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param text string +---@param chatType /y +---@param CHANNEL channel +---@param DND text +---@param EMOTE /e +---@param GUILD /g +---@param INSTANCE_CHAT /i +---@param OFFICER /o +---@param PARTY /p +---@param RAID /ra +---@param RAID_WARNING /rw +---@param SAY /s +---@param WHISPER channel +---@param YELL /y +---@param languageIndex number +---@param channel string +---Sends a chat message +function SendChatMessage(text, chatType, CHANNEL, DND, EMOTE, GUILD, INSTANCE_CHAT, OFFICER, PARTY, RAID, RAID_WARNING, SAY, WHISPER, YELL, languageIndex, channel) end \ No newline at end of file diff --git a/api/SendMail.lua b/api/SendMail.lua new file mode 100644 index 0000000..4d792cb --- /dev/null +++ b/api/SendMail.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param recipient string +---@param subject string +---@param body string +---Sends the outgoing message. Any money or COD costs and attachments specified for the mail (via SetSendMailMoney(), SetSendMailCOD(), and ClickSendMailItemButton()) are included with the mail (and the values for such are reset for the next outgoing mail). +function SendMail(recipient, subject, body) end \ No newline at end of file diff --git a/api/SendQuestChoiceResponse.lua b/api/SendQuestChoiceResponse.lua new file mode 100644 index 0000000..28c9367 --- /dev/null +++ b/api/SendQuestChoiceResponse.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SendQuestChoiceResponse() end \ No newline at end of file diff --git a/api/SendWho.lua b/api/SendWho.lua new file mode 100644 index 0000000..4285b4d --- /dev/null +++ b/api/SendWho.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param filter string +---Requests a list of characters meeting given search criteria from the server. Text in the query will match against any of the six searchable fields unless one of the specifiers below is used; multiple specifiers can be used in one query. Queries are case insensitive. n-"name" - Search for characters whose name contains name c-"class" - Search for characters whose class name contains class g-"guild" - Search for characters in guilds whose name contains guild r-"race" - Search for characters whose race name contains race z-"zone" - Search for characters in zones whose name contains zone X - Search for characters of level X X- - Search for characters of level X or higher -X - Search for characters of level X or lower X-Y - Search for characters between levels X and Y (inclusive) Results are not available immediately; the CHAT_MSG_SYSTEM or WHO_LIST_UPDATE event fires when data is available, as determined by the SetWhoToUI() function. +function SendWho(filter) end \ No newline at end of file diff --git a/api/SetAbandonQuest.lua b/api/SetAbandonQuest.lua new file mode 100644 index 0000000..c0999cb --- /dev/null +++ b/api/SetAbandonQuest.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param questIndex number +---Begins the process of abandoning a quest in the player's quest log. To finish abandoning the quest, call AbandonQuest(). This function must be called to select a quest in order for GetAbandonQuestItems() or GetAbandonQuestName() to return valid data. +function SetAbandonQuest(questIndex) end \ No newline at end of file diff --git a/api/SetAchievementComparisonPortrait.lua b/api/SetAchievementComparisonPortrait.lua new file mode 100644 index 0000000..db9a515 --- /dev/null +++ b/api/SetAchievementComparisonPortrait.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetAchievementComparisonPortrait() end \ No newline at end of file diff --git a/api/SetAchievementComparisonUnit.lua b/api/SetAchievementComparisonUnit.lua new file mode 100644 index 0000000..a251eaa --- /dev/null +++ b/api/SetAchievementComparisonUnit.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit unitID +---@return 1nil success +---Enables comparing achievements/statistics with another player. After a call to this function, the INSPECTACHIEVEMENTREADY event fires to indicate that achievement/statistic comparison functions will return valid data on the given unit. +function SetAchievementComparisonUnit(unit) end \ No newline at end of file diff --git a/api/SetActionBarToggles.lua b/api/SetActionBarToggles.lua new file mode 100644 index 0000000..40a3213 --- /dev/null +++ b/api/SetActionBarToggles.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param bar1 1nil +---@param bar2 1nil +---@param bar3 1nil +---@param bar4 1nil +---@param alwaysShow 1nil +---Configures display of additional ActionBars in the default UI +function SetActionBarToggles(bar1, bar2, bar3, bar4, alwaysShow) end \ No newline at end of file diff --git a/api/SetActionUIButton.lua b/api/SetActionUIButton.lua new file mode 100644 index 0000000..2a8b3f3 --- /dev/null +++ b/api/SetActionUIButton.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetActionUIButton() end \ No newline at end of file diff --git a/api/SetActiveSpecGroup.lua b/api/SetActiveSpecGroup.lua new file mode 100644 index 0000000..d1d7276 --- /dev/null +++ b/api/SetActiveSpecGroup.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetActiveSpecGroup() end \ No newline at end of file diff --git a/api/SetActiveVoiceChannel.lua b/api/SetActiveVoiceChannel.lua new file mode 100644 index 0000000..b4e21c8 --- /dev/null +++ b/api/SetActiveVoiceChannel.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Sets the currently active voice channel +function SetActiveVoiceChannel(index) end \ No newline at end of file diff --git a/api/SetActiveVoiceChannelBySessionID.lua b/api/SetActiveVoiceChannelBySessionID.lua new file mode 100644 index 0000000..0a400d2 --- /dev/null +++ b/api/SetActiveVoiceChannelBySessionID.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param session number +---Sets the currently active voice chat channel +function SetActiveVoiceChannelBySessionID(session) end \ No newline at end of file diff --git a/api/SetAddonVersionCheck.lua b/api/SetAddonVersionCheck.lua new file mode 100644 index 0000000..4161a16 --- /dev/null +++ b/api/SetAddonVersionCheck.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetAddonVersionCheck() end \ No newline at end of file diff --git a/api/SetAllowLowLevelRaid.lua b/api/SetAllowLowLevelRaid.lua new file mode 100644 index 0000000..9236849 --- /dev/null +++ b/api/SetAllowLowLevelRaid.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param enable boolean +---Enabling this if your character is below level 10 will allow you to join a raid group. +function SetAllowLowLevelRaid(enable) end \ No newline at end of file diff --git a/api/SetAuctionsTabShowing.lua b/api/SetAuctionsTabShowing.lua new file mode 100644 index 0000000..08be58d --- /dev/null +++ b/api/SetAuctionsTabShowing.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetAuctionsTabShowing() end \ No newline at end of file diff --git a/api/SetAutoDeclineGuildInvites.lua b/api/SetAutoDeclineGuildInvites.lua new file mode 100644 index 0000000..a562027 --- /dev/null +++ b/api/SetAutoDeclineGuildInvites.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetAutoDeclineGuildInvites() end \ No newline at end of file diff --git a/api/SetBackpackAutosortDisabled.lua b/api/SetBackpackAutosortDisabled.lua new file mode 100644 index 0000000..9c1fefc --- /dev/null +++ b/api/SetBackpackAutosortDisabled.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetBackpackAutosortDisabled() end \ No newline at end of file diff --git a/api/SetBagPortraitTexture.lua b/api/SetBagPortraitTexture.lua new file mode 100644 index 0000000..d55f317 --- /dev/null +++ b/api/SetBagPortraitTexture.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param texture table +---@param container number +---Sets a Texture object to display the icon of one of the player's bags. Adapts the square item icon texture to fit within the circular "portrait" frames used in many default UI elements. +function SetBagPortraitTexture(texture, container) end \ No newline at end of file diff --git a/api/SetBagSlotFlag.lua b/api/SetBagSlotFlag.lua new file mode 100644 index 0000000..9a487e6 --- /dev/null +++ b/api/SetBagSlotFlag.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetBagSlotFlag() end \ No newline at end of file diff --git a/api/SetBankAutosortDisabled.lua b/api/SetBankAutosortDisabled.lua new file mode 100644 index 0000000..8606cce --- /dev/null +++ b/api/SetBankAutosortDisabled.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetBankAutosortDisabled() end \ No newline at end of file diff --git a/api/SetBankBagSlotFlag.lua b/api/SetBankBagSlotFlag.lua new file mode 100644 index 0000000..1bff886 --- /dev/null +++ b/api/SetBankBagSlotFlag.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetBankBagSlotFlag() end \ No newline at end of file diff --git a/api/SetBarSlotFromIntro.lua b/api/SetBarSlotFromIntro.lua new file mode 100644 index 0000000..2075cd9 --- /dev/null +++ b/api/SetBarSlotFromIntro.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetBarSlotFromIntro() end \ No newline at end of file diff --git a/api/SetBarberShopAlternateFormFrame.lua b/api/SetBarberShopAlternateFormFrame.lua new file mode 100644 index 0000000..6177feb --- /dev/null +++ b/api/SetBarberShopAlternateFormFrame.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetBarberShopAlternateFormFrame() end \ No newline at end of file diff --git a/api/SetBattlefieldScoreFaction.lua b/api/SetBattlefieldScoreFaction.lua new file mode 100644 index 0000000..8cd5649 --- /dev/null +++ b/api/SetBattlefieldScoreFaction.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param faction nil +---@param 0 +---@param 1 +---@param nil +---Filters the battleground scoreboard by faction/team +function SetBattlefieldScoreFaction(faction, 0, 1, nil) end \ No newline at end of file diff --git a/api/SetBinding.lua b/api/SetBinding.lua new file mode 100644 index 0000000..a3e8486 --- /dev/null +++ b/api/SetBinding.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param key string +---@param command string +---@return 1nil success +---Binds a key combination to a binding command +function SetBinding(key, command) end \ No newline at end of file diff --git a/api/SetBindingClick.lua b/api/SetBindingClick.lua new file mode 100644 index 0000000..c4ed2e1 --- /dev/null +++ b/api/SetBindingClick.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param key string +---@param buttonName string +---@param mouseButton string +---@return 1nil success +---Binds a key combination to "click" a Button object. When the binding is used, all of the relevant mouse handlers on the button (save for OnEnter and OnLeave) fire just as if the button were activated by the mouse (including OnMouseDown and OnMouseUp as the key is pressed and released). +function SetBindingClick(key, buttonName, mouseButton) end \ No newline at end of file diff --git a/api/SetBindingItem.lua b/api/SetBindingItem.lua new file mode 100644 index 0000000..08030ec --- /dev/null +++ b/api/SetBindingItem.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param key string +---@param itemID number +---@param itemName string +---@param itemLink string +---@return 1nil success +---Binds a key combination to use an item in the player's possession +function SetBindingItem(key, itemID, itemName, itemLink) end \ No newline at end of file diff --git a/api/SetBindingMacro.lua b/api/SetBindingMacro.lua new file mode 100644 index 0000000..f9c2ea5 --- /dev/null +++ b/api/SetBindingMacro.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param key string +---@param index number +---@param name string +---@return 1nil success +---Binds a key combination to run a macro +function SetBindingMacro(key, index, name) end \ No newline at end of file diff --git a/api/SetBindingSpell.lua b/api/SetBindingSpell.lua new file mode 100644 index 0000000..c705e5f --- /dev/null +++ b/api/SetBindingSpell.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param key string +---@param spellname string +---@return 1nil success +---Binds a key combination to cast a spell +function SetBindingSpell(key, spellname) end \ No newline at end of file diff --git a/api/SetBlacklistMap.lua b/api/SetBlacklistMap.lua new file mode 100644 index 0000000..7ec62fa --- /dev/null +++ b/api/SetBlacklistMap.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetBlacklistMap() end \ No newline at end of file diff --git a/api/SetCVar.lua b/api/SetCVar.lua new file mode 100644 index 0000000..2cc4fa9 --- /dev/null +++ b/api/SetCVar.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param cvar string +---@param value any +---@param raiseEvent string +---Sets the value of a configuration variable +function SetCVar(cvar, value, raiseEvent) end \ No newline at end of file diff --git a/api/SetCVarBitfield.lua b/api/SetCVarBitfield.lua new file mode 100644 index 0000000..ae77834 --- /dev/null +++ b/api/SetCVarBitfield.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetCVarBitfield() end \ No newline at end of file diff --git a/api/SetCemeteryPreference.lua b/api/SetCemeteryPreference.lua new file mode 100644 index 0000000..ce12668 --- /dev/null +++ b/api/SetCemeteryPreference.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetCemeteryPreference() end \ No newline at end of file diff --git a/api/SetChannelOwner.lua b/api/SetChannelOwner.lua new file mode 100644 index 0000000..d4ee7f2 --- /dev/null +++ b/api/SetChannelOwner.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param channel string +---@param fullname string +---Gives channel ownership to another character. Has no effect unless the player is the owner of the given channel. +function SetChannelOwner(channel, fullname) end \ No newline at end of file diff --git a/api/SetChannelPassword.lua b/api/SetChannelPassword.lua new file mode 100644 index 0000000..01b6279 --- /dev/null +++ b/api/SetChannelPassword.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param channel string +---@param password string +---Sets a password on a custom chat channel +function SetChannelPassword(channel, password) end \ No newline at end of file diff --git a/api/SetChatColorNameByClass.lua b/api/SetChatColorNameByClass.lua new file mode 100644 index 0000000..d1e1c6b --- /dev/null +++ b/api/SetChatColorNameByClass.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param chatType string +---@param colorByName boolean +---Sets whether the player names should be colored by class for a given chat type +function SetChatColorNameByClass(chatType, colorByName) end \ No newline at end of file diff --git a/api/SetChatWindowAlpha.lua b/api/SetChatWindowAlpha.lua new file mode 100644 index 0000000..cf6defa --- /dev/null +++ b/api/SetChatWindowAlpha.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param alpha number +---Saves a chat window's background opacity setting. Used by the default UI's function FCF_SetWindowAlpha() which changes the opacity of a displayed FloatingChatFrame. +function SetChatWindowAlpha(index, alpha) end \ No newline at end of file diff --git a/api/SetChatWindowColor.lua b/api/SetChatWindowColor.lua new file mode 100644 index 0000000..cc6da31 --- /dev/null +++ b/api/SetChatWindowColor.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param r number +---@param g number +---@param b number +---Saves a chat window's background color setting. Used by the default UI's function FCF_SetWindowColor() which changes the colors of a displayed FloatingChatFrame. +function SetChatWindowColor(index, r, g, b) end \ No newline at end of file diff --git a/api/SetChatWindowDocked.lua b/api/SetChatWindowDocked.lua new file mode 100644 index 0000000..05c5a72 --- /dev/null +++ b/api/SetChatWindowDocked.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param docked boolean +---Saves whether a chat window should be docked with the main chat window. Used by the default UI's functions FCF_DockFrame() and FCF_UnDockFrame() which manage the positioning of FloatingChatFrames. +function SetChatWindowDocked(index, docked) end \ No newline at end of file diff --git a/api/SetChatWindowLocked.lua b/api/SetChatWindowLocked.lua new file mode 100644 index 0000000..18c2f80 --- /dev/null +++ b/api/SetChatWindowLocked.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param locked boolean +---Saves whether a chat window is locked. Used by the default UI's functions FCF_OpenNewWindow() and FCF_SetLocked() which manage the behavior of a FloatingChatFrame. +function SetChatWindowLocked(index, locked) end \ No newline at end of file diff --git a/api/SetChatWindowName.lua b/api/SetChatWindowName.lua new file mode 100644 index 0000000..4232aa7 --- /dev/null +++ b/api/SetChatWindowName.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param name string +---Saves a chat window's display name setting. Used by the default UI's function FCF_SetWindowName() which also handles setting the name displayed for a FloatingChatFrame. +function SetChatWindowName(index, name) end \ No newline at end of file diff --git a/api/SetChatWindowSavedDimensions.lua b/api/SetChatWindowSavedDimensions.lua new file mode 100644 index 0000000..3dbb4da --- /dev/null +++ b/api/SetChatWindowSavedDimensions.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetChatWindowSavedDimensions() end \ No newline at end of file diff --git a/api/SetChatWindowSavedPosition.lua b/api/SetChatWindowSavedPosition.lua new file mode 100644 index 0000000..d107741 --- /dev/null +++ b/api/SetChatWindowSavedPosition.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetChatWindowSavedPosition() end \ No newline at end of file diff --git a/api/SetChatWindowShown.lua b/api/SetChatWindowShown.lua new file mode 100644 index 0000000..d27a929 --- /dev/null +++ b/api/SetChatWindowShown.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param shown boolean +---Saves whether a chat window should be shown. Used by the default UI's function FCF_OpenNewWindow() which initializes a displayed FloatingChatFrame. +function SetChatWindowShown(index, shown) end \ No newline at end of file diff --git a/api/SetChatWindowSize.lua b/api/SetChatWindowSize.lua new file mode 100644 index 0000000..3388089 --- /dev/null +++ b/api/SetChatWindowSize.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param size number +---Saves a chat window's font size setting. Used by the default UI's function FCF_SetChatWindowFontSize() which also handles changing the font displayed in a FloatingChatFrame. +function SetChatWindowSize(index, size) end \ No newline at end of file diff --git a/api/SetChatWindowUninteractable.lua b/api/SetChatWindowUninteractable.lua new file mode 100644 index 0000000..2f81505 --- /dev/null +++ b/api/SetChatWindowUninteractable.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param setUninteractable boolean +---Saves whether a chat window is marked as non-interactive. Used by the default UI's function FCF_SetUninteractable() which also handles enabling/disabling mouse events in the FloatingChatFrame. +function SetChatWindowUninteractable(index, setUninteractable) end \ No newline at end of file diff --git a/api/SetConsoleKey.lua b/api/SetConsoleKey.lua new file mode 100644 index 0000000..2b1e588 --- /dev/null +++ b/api/SetConsoleKey.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetConsoleKey() end \ No newline at end of file diff --git a/api/SetCurrencyBackpack.lua b/api/SetCurrencyBackpack.lua new file mode 100644 index 0000000..02c732e --- /dev/null +++ b/api/SetCurrencyBackpack.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param watch number +---Sets a currency type to be watched on the Backpack UI +function SetCurrencyBackpack(index, watch) end \ No newline at end of file diff --git a/api/SetCurrencyUnused.lua b/api/SetCurrencyUnused.lua new file mode 100644 index 0000000..1356cae --- /dev/null +++ b/api/SetCurrencyUnused.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param makeUnused number +---Moves a currency type to or from the Unused currencies list. "Unused" currencies behave no differently; the distinction only exists to allow players to hide currencies they don't care about from the main display. +function SetCurrencyUnused(index, makeUnused) end \ No newline at end of file diff --git a/api/SetCurrentGraphicsSetting.lua b/api/SetCurrentGraphicsSetting.lua new file mode 100644 index 0000000..75b87ac --- /dev/null +++ b/api/SetCurrentGraphicsSetting.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetCurrentGraphicsSetting() end \ No newline at end of file diff --git a/api/SetCurrentGuildBankTab.lua b/api/SetCurrentGuildBankTab.lua new file mode 100644 index 0000000..39c7cf8 --- /dev/null +++ b/api/SetCurrentGuildBankTab.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param tab number +---Selects a tab in the guild bank +function SetCurrentGuildBankTab(tab) end \ No newline at end of file diff --git a/api/SetCurrentTitle.lua b/api/SetCurrentTitle.lua new file mode 100644 index 0000000..d5f939e --- /dev/null +++ b/api/SetCurrentTitle.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param titleIndex integer +---Changes a player's displayed title +function SetCurrentTitle(titleIndex) end \ No newline at end of file diff --git a/api/SetCursor.lua b/api/SetCursor.lua new file mode 100644 index 0000000..3dc26f3 --- /dev/null +++ b/api/SetCursor.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param cursor string +---Changes the mouse cursor image. Changes only the appearance of the mouse cursor, not its behavior (and has no effect if the cursor is holding an item, spell, or other data). Passing nil will revert the cursor to its default image. Normally used in a frame's OnEnter handler to change the cursor used while the mouse is over the frame. If used elsewhere, the cursor will likely be immediately reverted to default (due to the mouse handlers of other frames doing the same). +function SetCursor(cursor) end \ No newline at end of file diff --git a/api/SetDefaultVideoOptions.lua b/api/SetDefaultVideoOptions.lua new file mode 100644 index 0000000..4969203 --- /dev/null +++ b/api/SetDefaultVideoOptions.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetDefaultVideoOptions() end \ No newline at end of file diff --git a/api/SetDungeonMapLevel.lua b/api/SetDungeonMapLevel.lua new file mode 100644 index 0000000..fc69dcf --- /dev/null +++ b/api/SetDungeonMapLevel.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param level number +---Sets the world map to display a certain map image (for zones that use multiple map images). Used in zones with more than one "floor" or area such as Dalaran and several Wrath of the Lich King dungeons and raids. +function SetDungeonMapLevel(level) end \ No newline at end of file diff --git a/api/SetEuropeanNumbers.lua b/api/SetEuropeanNumbers.lua new file mode 100644 index 0000000..a2db0fa --- /dev/null +++ b/api/SetEuropeanNumbers.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param enable boolean +---Sets the decimal separator for displayed numbers. Affects the style not only of numbers displayed in the UI, but any string coercion of numbers with tostring() as well. +function SetEuropeanNumbers(enable) end \ No newline at end of file diff --git a/api/SetEveryoneIsAssistant.lua b/api/SetEveryoneIsAssistant.lua new file mode 100644 index 0000000..b60c140 --- /dev/null +++ b/api/SetEveryoneIsAssistant.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetEveryoneIsAssistant() end \ No newline at end of file diff --git a/api/SetFactionActive.lua b/api/SetFactionActive.lua new file mode 100644 index 0000000..748915f --- /dev/null +++ b/api/SetFactionActive.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Removes the "inactive" status from a faction. "Inactive" factions behave no differently; the distinction only exists to allow players to hide factions they don't care about from the main display. Factions thus marked are automatically moved to an "Inactive" group at the end of the faction list. +function SetFactionActive(index) end \ No newline at end of file diff --git a/api/SetFactionInactive.lua b/api/SetFactionInactive.lua new file mode 100644 index 0000000..d588597 --- /dev/null +++ b/api/SetFactionInactive.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Flags a faction as inactive. "Inactive" factions behave no differently; the distinction only exists to allow players to hide factions they don't care about from the main display. Factions thus marked are automatically moved to an "Inactive" group at the end of the faction list. +function SetFactionInactive(index) end \ No newline at end of file diff --git a/api/SetFocusedAchievement.lua b/api/SetFocusedAchievement.lua new file mode 100644 index 0000000..4a99f1c --- /dev/null +++ b/api/SetFocusedAchievement.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetFocusedAchievement() end \ No newline at end of file diff --git a/api/SetFriendNotes.lua b/api/SetFriendNotes.lua new file mode 100644 index 0000000..7c4259d --- /dev/null +++ b/api/SetFriendNotes.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param name string +---@param note string +---Sets note text associated with a friends list entry. Setting a note to nil will result in an error; to remove a note, set it to the empty string (""). +function SetFriendNotes(index, name, note) end \ No newline at end of file diff --git a/api/SetGamma.lua b/api/SetGamma.lua new file mode 100644 index 0000000..0e6d72b --- /dev/null +++ b/api/SetGamma.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param value number +---Changes the display gamma setting. Gamma value determines the contrast between lighter and darker portions of the game display; for a detailed explanation see the Wikipedia article on Gamma corection. +function SetGamma(value) end \ No newline at end of file diff --git a/api/SetGlyphFilter.lua b/api/SetGlyphFilter.lua new file mode 100644 index 0000000..c20d29a --- /dev/null +++ b/api/SetGlyphFilter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetGlyphFilter() end \ No newline at end of file diff --git a/api/SetGlyphNameFilter.lua b/api/SetGlyphNameFilter.lua new file mode 100644 index 0000000..72eae4a --- /dev/null +++ b/api/SetGlyphNameFilter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetGlyphNameFilter() end \ No newline at end of file diff --git a/api/SetGuildApplicantSelection.lua b/api/SetGuildApplicantSelection.lua new file mode 100644 index 0000000..8165aea --- /dev/null +++ b/api/SetGuildApplicantSelection.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetGuildApplicantSelection() end \ No newline at end of file diff --git a/api/SetGuildBankTabInfo.lua b/api/SetGuildBankTabInfo.lua new file mode 100644 index 0000000..f13dccc --- /dev/null +++ b/api/SetGuildBankTabInfo.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param tab number +---@param name string +---@param iconIndex number +---Sets the name and icon for a guild bank tab +function SetGuildBankTabInfo(tab, name, iconIndex) end \ No newline at end of file diff --git a/api/SetGuildBankTabItemWithdraw.lua b/api/SetGuildBankTabItemWithdraw.lua new file mode 100644 index 0000000..38d9c59 --- /dev/null +++ b/api/SetGuildBankTabItemWithdraw.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetGuildBankTabItemWithdraw() end \ No newline at end of file diff --git a/api/SetGuildBankTabPermissions.lua b/api/SetGuildBankTabPermissions.lua new file mode 100644 index 0000000..f0bfcdf --- /dev/null +++ b/api/SetGuildBankTabPermissions.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param tab number +---@param permission 2 +---@param 1 +---@param 2 +---@param enabled boolean +---Changes guild bank tab permissions for the guild rank being edited +function SetGuildBankTabPermissions(tab, permission, 1, 2, enabled) end \ No newline at end of file diff --git a/api/SetGuildBankText.lua b/api/SetGuildBankText.lua new file mode 100644 index 0000000..d8be8e4 --- /dev/null +++ b/api/SetGuildBankText.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param tab number +---@param text string +---Sets the info text for a guild bank tab +function SetGuildBankText(tab, text) end \ No newline at end of file diff --git a/api/SetGuildBankWithdrawGoldLimit.lua b/api/SetGuildBankWithdrawGoldLimit.lua new file mode 100644 index 0000000..0a09c20 --- /dev/null +++ b/api/SetGuildBankWithdrawGoldLimit.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetGuildBankWithdrawGoldLimit() end \ No newline at end of file diff --git a/api/SetGuildInfoText.lua b/api/SetGuildInfoText.lua new file mode 100644 index 0000000..0802c65 --- /dev/null +++ b/api/SetGuildInfoText.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param text string +---Sets the guild information text.. This text appears when clicking the "Guild Information" button in the default UI's Guild window. +function SetGuildInfoText(text) end \ No newline at end of file diff --git a/api/SetGuildMemberRank.lua b/api/SetGuildMemberRank.lua new file mode 100644 index 0000000..314d181 --- /dev/null +++ b/api/SetGuildMemberRank.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param rankIndex number +---Promotes/demotes a given guild member to the specified rank +function SetGuildMemberRank(index, rankIndex) end \ No newline at end of file diff --git a/api/SetGuildNewsFilter.lua b/api/SetGuildNewsFilter.lua new file mode 100644 index 0000000..aecb0c8 --- /dev/null +++ b/api/SetGuildNewsFilter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetGuildNewsFilter() end \ No newline at end of file diff --git a/api/SetGuildRecruitmentComment.lua b/api/SetGuildRecruitmentComment.lua new file mode 100644 index 0000000..c24b7cc --- /dev/null +++ b/api/SetGuildRecruitmentComment.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetGuildRecruitmentComment() end \ No newline at end of file diff --git a/api/SetGuildRecruitmentSettings.lua b/api/SetGuildRecruitmentSettings.lua new file mode 100644 index 0000000..fec3afb --- /dev/null +++ b/api/SetGuildRecruitmentSettings.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetGuildRecruitmentSettings() end \ No newline at end of file diff --git a/api/SetGuildRosterSelection.lua b/api/SetGuildRosterSelection.lua new file mode 100644 index 0000000..134895f --- /dev/null +++ b/api/SetGuildRosterSelection.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Selects a member in the guild roster. Selection in the guild roster is used only for display in the default UI and has no effect on other Guild APIs. +function SetGuildRosterSelection(index) end \ No newline at end of file diff --git a/api/SetGuildRosterShowOffline.lua b/api/SetGuildRosterShowOffline.lua new file mode 100644 index 0000000..7b96e12 --- /dev/null +++ b/api/SetGuildRosterShowOffline.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param showOffline boolean +---Enables or disables inclusion of offline members in the guild roster listing +function SetGuildRosterShowOffline(showOffline) end \ No newline at end of file diff --git a/api/SetGuildTradeSkillCategoryFilter.lua b/api/SetGuildTradeSkillCategoryFilter.lua new file mode 100644 index 0000000..9ec5956 --- /dev/null +++ b/api/SetGuildTradeSkillCategoryFilter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetGuildTradeSkillCategoryFilter() end \ No newline at end of file diff --git a/api/SetGuildTradeSkillItemNameFilter.lua b/api/SetGuildTradeSkillItemNameFilter.lua new file mode 100644 index 0000000..41a207c --- /dev/null +++ b/api/SetGuildTradeSkillItemNameFilter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetGuildTradeSkillItemNameFilter() end \ No newline at end of file diff --git a/api/SetInsertItemsLeftToRight.lua b/api/SetInsertItemsLeftToRight.lua new file mode 100644 index 0000000..16dba6e --- /dev/null +++ b/api/SetInsertItemsLeftToRight.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetInsertItemsLeftToRight() end \ No newline at end of file diff --git a/api/SetInventoryPortraitTexture.lua b/api/SetInventoryPortraitTexture.lua new file mode 100644 index 0000000..6cd1e4c --- /dev/null +++ b/api/SetInventoryPortraitTexture.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param texture table +---@param unit string +---@param slot number +---Sets a Texture object to display the icon of an equipped item. Adapts the square item icon texture to fit within the circular "portrait" frames used in many default UI elements. +function SetInventoryPortraitTexture(texture, unit, slot) end \ No newline at end of file diff --git a/api/SetItemSearch.lua b/api/SetItemSearch.lua new file mode 100644 index 0000000..32fe6c4 --- /dev/null +++ b/api/SetItemSearch.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetItemSearch() end \ No newline at end of file diff --git a/api/SetItemUpgradeFromCursorItem.lua b/api/SetItemUpgradeFromCursorItem.lua new file mode 100644 index 0000000..48eaead --- /dev/null +++ b/api/SetItemUpgradeFromCursorItem.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Puts an item into the item upgrade dialog. This function can currently only be called when at the upgrade merchant +function SetItemUpgradeFromCursorItem() end \ No newline at end of file diff --git a/api/SetLFGBonusFactionID.lua b/api/SetLFGBonusFactionID.lua new file mode 100644 index 0000000..24d2fa1 --- /dev/null +++ b/api/SetLFGBonusFactionID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetLFGBonusFactionID() end \ No newline at end of file diff --git a/api/SetLFGBootVote.lua b/api/SetLFGBootVote.lua new file mode 100644 index 0000000..cde1cb6 --- /dev/null +++ b/api/SetLFGBootVote.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetLFGBootVote() end \ No newline at end of file diff --git a/api/SetLFGComment.lua b/api/SetLFGComment.lua new file mode 100644 index 0000000..8e763c7 --- /dev/null +++ b/api/SetLFGComment.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param comment string +---Associates a brief text comment with the player's listing in the LFG system. In the default UI, other players see this comment when mousing over the player's name in the Looking for More listing. +function SetLFGComment(comment) end \ No newline at end of file diff --git a/api/SetLFGDungeon.lua b/api/SetLFGDungeon.lua new file mode 100644 index 0000000..cc30f97 --- /dev/null +++ b/api/SetLFGDungeon.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param queueIndex number +---Sets a flag indicating that the player would like to join a given dungeon/queue. This function simply indicates that the player would like to join a given dungeon or queue. Joining the queue is accomplished using the JoinLFG() function. Clearing the dungeons that have been flagged is accomplished using the ClearAllLFGDungeons function. +function SetLFGDungeon(queueIndex) end \ No newline at end of file diff --git a/api/SetLFGDungeonEnabled.lua b/api/SetLFGDungeonEnabled.lua new file mode 100644 index 0000000..a2e566c --- /dev/null +++ b/api/SetLFGDungeonEnabled.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetLFGDungeonEnabled() end \ No newline at end of file diff --git a/api/SetLFGHeaderCollapsed.lua b/api/SetLFGHeaderCollapsed.lua new file mode 100644 index 0000000..3612fae --- /dev/null +++ b/api/SetLFGHeaderCollapsed.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetLFGHeaderCollapsed() end \ No newline at end of file diff --git a/api/SetLFGRoles.lua b/api/SetLFGRoles.lua new file mode 100644 index 0000000..c65eff2 --- /dev/null +++ b/api/SetLFGRoles.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param leader boolean +---@param tank boolean +---@param healer boolean +---@param damage boolean +---Sets group roles for which to advertise the player in the LFG system. Passing true for a role the player's class does not support (e.g. healing on a warrior or tanking on a priest) has no effect: see example. +function SetLFGRoles(leader, tank, healer, damage) end \ No newline at end of file diff --git a/api/SetLayoutMode.lua b/api/SetLayoutMode.lua new file mode 100644 index 0000000..17e2441 --- /dev/null +++ b/api/SetLayoutMode.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetLayoutMode() end \ No newline at end of file diff --git a/api/SetLegacyRaidDifficultyID.lua b/api/SetLegacyRaidDifficultyID.lua new file mode 100644 index 0000000..3701ead --- /dev/null +++ b/api/SetLegacyRaidDifficultyID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetLegacyRaidDifficultyID() end \ No newline at end of file diff --git a/api/SetLookingForGuildComment.lua b/api/SetLookingForGuildComment.lua new file mode 100644 index 0000000..b11e38e --- /dev/null +++ b/api/SetLookingForGuildComment.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetLookingForGuildComment() end \ No newline at end of file diff --git a/api/SetLookingForGuildSettings.lua b/api/SetLookingForGuildSettings.lua new file mode 100644 index 0000000..7a09b34 --- /dev/null +++ b/api/SetLookingForGuildSettings.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetLookingForGuildSettings() end \ No newline at end of file diff --git a/api/SetLootMethod.lua b/api/SetLootMethod.lua new file mode 100644 index 0000000..6556183 --- /dev/null +++ b/api/SetLootMethod.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param method roundrobin +---@param freeforall +---@param group +---@param master +---@param needbeforegreed +---@param roundrobin +---@param master string +---Sets the loot method for a party or raid group. Has no effect if the player is not the party or raid leader. See SetLootThreshold for the quality threshold used by Master Looter, Group Loot, and Need Before Greed methods. +function SetLootMethod(method, freeforall, group, master, needbeforegreed, roundrobin, master) end \ No newline at end of file diff --git a/api/SetLootPortrait.lua b/api/SetLootPortrait.lua new file mode 100644 index 0000000..75c9eee --- /dev/null +++ b/api/SetLootPortrait.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param texture table +---Sets a Texture object to show the appropriate portrait image when looting. Normally, the loot portrait image is the same as that of the creature being looted. Not used in the default UI -- a generic image for all loot is used instead. +function SetLootPortrait(texture) end \ No newline at end of file diff --git a/api/SetLootSpecialization.lua b/api/SetLootSpecialization.lua new file mode 100644 index 0000000..0703fc1 --- /dev/null +++ b/api/SetLootSpecialization.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param specID number +---Sets the current loot specialization using a global specialization ID. If the argument is invalid or 0, the loot specialization will be set to Current Specialization, or automatic. +function SetLootSpecialization(specID) end \ No newline at end of file diff --git a/api/SetLootThreshold.lua b/api/SetLootThreshold.lua new file mode 100644 index 0000000..a92b69d --- /dev/null +++ b/api/SetLootThreshold.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param threshold number +---Sets the threshold used for Master Looter, Group Loot, and Need Before Greed loot methods. Has no effect if the player is not the party or raid leader. Items above the threshold quality will trigger the special behavior of the current loot method: for Group Loot and Need Before Greed, rolling will automatically begin once a group member loots the corpse or object holding the item; for Master Loot, the item will be invisible to all but the loot master tasked with assigning the loot. The loot threshold defaults to 2 (Uncommon) when forming a new party/raid. Setting the threshold to 0 (Poor) or 1 (Common) has no effect -- qualities below Uncommon are always treated as below the threshold. The default UI only allows setting the threshold as high as 4 (Epic), but higher thresholds are allowed. +function SetLootThreshold(threshold) end \ No newline at end of file diff --git a/api/SetMacroItem.lua b/api/SetMacroItem.lua new file mode 100644 index 0000000..a7631e8 --- /dev/null +++ b/api/SetMacroItem.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param name string +---@param item string +---@param target unitid +---Changes the item used for dynamic feedback for a macro. Normally a macro uses the item or spell specified by its commands to provide dynamic feedback when placed on an action button (through the Action APIs, e.g. IsActionUsable()): e.g. if the macro uses a consumable item, the button will show the number of items remaining; if the macro uses an item with a cooldown, the button will show the state of the cooldown. This function allows overriding the item or spell used by the macro with another item -- the given item's state will be used for such feedback instead of the item or spell used by the macro. +function SetMacroItem(index, name, item, target) end \ No newline at end of file diff --git a/api/SetMacroSpell.lua b/api/SetMacroSpell.lua new file mode 100644 index 0000000..83433e9 --- /dev/null +++ b/api/SetMacroSpell.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param name string +---@param spell string +---@param target unitid +---Changes the spell used for dynamic feedback for a macro. Normally a macro uses the item or spell specified by its commands to provide dynamic feedback when placed on an action button (through the Action APIs, e.g. IsActionUsable()): e.g. if the macro uses a consumable item, the button will show the number of items remaining; if the macro uses an item with a cooldown, the button will show the state of the cooldown. This function allows overriding the item or spell used by the macro with another item -- the given item's state will be used for such feedback instead of the item or spell used by the macro. +function SetMacroSpell(index, name, spell, target) end \ No newline at end of file diff --git a/api/SetMapByID.lua b/api/SetMapByID.lua new file mode 100644 index 0000000..159d878 --- /dev/null +++ b/api/SetMapByID.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param id number +---Sets the map based on a specified ID. For example, if you are an Undead character in the starting area, which is map ID 21, you can open your map and run SetMapByID(22) to change it to Western Plaguelands. In fact, you can run that anywhere If you are a fresh undead in tirisfal glades(MapAreaID:21), you get your map out, then you use SetMapByID(22) it will change to WPL +function SetMapByID(id) end \ No newline at end of file diff --git a/api/SetMapToCurrentZone.lua b/api/SetMapToCurrentZone.lua new file mode 100644 index 0000000..4abef22 --- /dev/null +++ b/api/SetMapToCurrentZone.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Sets the world map to show the zone in which the player is located +function SetMapToCurrentZone() end \ No newline at end of file diff --git a/api/SetMapZoom.lua b/api/SetMapZoom.lua new file mode 100644 index 0000000..58d6cef --- /dev/null +++ b/api/SetMapZoom.lua @@ -0,0 +1,15 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param continentIndex 7 +---@param -1 +---@param 0 +---@param 1 +---@param 2 +---@param 3 +---@param 4 +---@param 5 +---@param 6 +---@param 7 +---@param zoneIndex number +---Sets the world map to show a specific zone or continent +function SetMapZoom(continentIndex, -1, 0, 1, 2, 3, 4, 5, 6, 7, zoneIndex) end \ No newline at end of file diff --git a/api/SetMaxAnimFramerate.lua b/api/SetMaxAnimFramerate.lua new file mode 100644 index 0000000..bed622f --- /dev/null +++ b/api/SetMaxAnimFramerate.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetMaxAnimFramerate() end \ No newline at end of file diff --git a/api/SetMerchantFilter.lua b/api/SetMerchantFilter.lua new file mode 100644 index 0000000..b6f33a3 --- /dev/null +++ b/api/SetMerchantFilter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetMerchantFilter() end \ No newline at end of file diff --git a/api/SetModifiedClick.lua b/api/SetModifiedClick.lua new file mode 100644 index 0000000..eb9e6bb --- /dev/null +++ b/api/SetModifiedClick.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param action string +---@param binding string +---Sets a modified click for a given action +function SetModifiedClick(action, binding) end \ No newline at end of file diff --git a/api/SetMouselookOverrideBinding.lua b/api/SetMouselookOverrideBinding.lua new file mode 100644 index 0000000..2d3e112 --- /dev/null +++ b/api/SetMouselookOverrideBinding.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param key BUTTON2 +---@param BUTTON1 +---@param BUTTON2 +---@param binding string +---Overrides the default mouselook bindings to perform another binding with the mouse buttons +function SetMouselookOverrideBinding(key, BUTTON1, BUTTON2, binding) end \ No newline at end of file diff --git a/api/SetMultiCastSpell.lua b/api/SetMultiCastSpell.lua new file mode 100644 index 0000000..378a545 --- /dev/null +++ b/api/SetMultiCastSpell.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param action number +---@param spell number +---Sets a multi-cast action slot to a given spell. This function is used to set up the multi-cast action slots, such as the totem bar that was introduced with WoW 3.2. The player is able to customize three different sets of totems that can then be cast with a single click. +function SetMultiCastSpell(action, spell) end \ No newline at end of file diff --git a/api/SetNamePlateMotionType.lua b/api/SetNamePlateMotionType.lua new file mode 100644 index 0000000..949c490 --- /dev/null +++ b/api/SetNamePlateMotionType.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetNamePlateMotionType() end \ No newline at end of file diff --git a/api/SetNextBarberShopStyle.lua b/api/SetNextBarberShopStyle.lua new file mode 100644 index 0000000..98953c0 --- /dev/null +++ b/api/SetNextBarberShopStyle.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param styleIndex 3 +---@param 1 +---@param 2 +---@param 3 +---@param reverse boolean +---Selects the next style for a barber shop style option. Changes the underlying data (and thus the character's appearance) only; the default barbershop UI does not update. +function SetNextBarberShopStyle(styleIndex, 1, 2, 3, reverse) end \ No newline at end of file diff --git a/api/SetOptOutOfLoot.lua b/api/SetOptOutOfLoot.lua new file mode 100644 index 0000000..e56e670 --- /dev/null +++ b/api/SetOptOutOfLoot.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param enable boolean +---Changes the player's preference to opt out of loot rolls. When opting out, no prompt will be shown for loot which ordinarily would prompt the player to roll (need/greed) or pass; the loot rolling process will continue for other group members as if the player had chosen to pass on every roll. +function SetOptOutOfLoot(enable) end \ No newline at end of file diff --git a/api/SetOverrideBinding.lua b/api/SetOverrideBinding.lua new file mode 100644 index 0000000..8375971 --- /dev/null +++ b/api/SetOverrideBinding.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param owner table +---@param isPriority boolean +---@param key string +---@param command string +---Sets an override binding for a binding command. Override bindings are temporary. The bound key will revert to its normal setting once the override is removed. Priority overrides work the same way but will revert to the previous override binding (if present) rather than the base binding for the key. Call with a fourth argument of nil to remove the override binding for a specific key, or see ClearOverrideBindings() to remove all bindings associated with a given owner. +function SetOverrideBinding(owner, isPriority, key, command) end \ No newline at end of file diff --git a/api/SetOverrideBindingClick.lua b/api/SetOverrideBindingClick.lua new file mode 100644 index 0000000..4659c56 --- /dev/null +++ b/api/SetOverrideBindingClick.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param owner table +---@param isPriority boolean +---@param key string +---@param buttonName string +---@param mouseButton string +---Sets an override binding to "click" a Button object. Override bindings are temporary. The bound key will revert to its normal setting once the override is removed. Priority overrides work the same way but will revert to the previous override binding (if present) rather than the base binding for the key. Call with a fourth argument of nil to remove the override binding for a specific key, or see ClearOverrideBindings() to remove all bindings associated with a given owner. +function SetOverrideBindingClick(owner, isPriority, key, buttonName, mouseButton) end \ No newline at end of file diff --git a/api/SetOverrideBindingItem.lua b/api/SetOverrideBindingItem.lua new file mode 100644 index 0000000..a68b510 --- /dev/null +++ b/api/SetOverrideBindingItem.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param owner table +---@param isPriority boolean +---@param key string +---@param itemID number +---@param itemName string +---@param itemLink string +---Sets an override binding to use an item in the player's possession. Override bindings are temporary. The bound key will revert to its normal setting once the override is removed. Priority overrides work the same way but will revert to the previous override binding (if present) rather than the base binding for the key. Call with a fourth argument of nil to remove the override binding for a specific key, or see ClearOverrideBindings() to remove all bindings associated with a given owner. +function SetOverrideBindingItem(owner, isPriority, key, itemID, itemName, itemLink) end \ No newline at end of file diff --git a/api/SetOverrideBindingMacro.lua b/api/SetOverrideBindingMacro.lua new file mode 100644 index 0000000..13dd06f --- /dev/null +++ b/api/SetOverrideBindingMacro.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param owner table +---@param isPriority boolean +---@param key string +---@param index number +---@param name string +---Sets an override binding to run a macro. Override bindings are temporary. The bound key will revert to its normal setting once the override is removed. Priority overrides work the same way but will revert to the previous override binding (if present) rather than the base binding for the key. Call with a fourth argument of nil to remove the override binding for a specific key, or see ClearOverrideBindings() to remove all bindings associated with a given owner. +function SetOverrideBindingMacro(owner, isPriority, key, index, name) end \ No newline at end of file diff --git a/api/SetOverrideBindingSpell.lua b/api/SetOverrideBindingSpell.lua new file mode 100644 index 0000000..73b3299 --- /dev/null +++ b/api/SetOverrideBindingSpell.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param owner table +---@param isPriority boolean +---@param key string +---@param spellname string +---Set an override binding to a specific spell. Override bindings are temporary. The bound key will revert to its normal setting once the override is removed. Priority overrides work the same way but will revert to the previous override binding (if present) rather than the base binding for the key. See ClearOverrideBindings() to remove bindings associated with a given owner. +function SetOverrideBindingSpell(owner, isPriority, key, spellname) end \ No newline at end of file diff --git a/api/SetPVP.lua b/api/SetPVP.lua new file mode 100644 index 0000000..6e594d1 --- /dev/null +++ b/api/SetPVP.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param state 1nil +---Enables or disables the player's desired PvP status. Enabling PvP takes effect immediately; disabling PvP begins a five-minute countdown after which PvP status will be disabled (if the player has taken no PvP actions). +function SetPVP(state) end \ No newline at end of file diff --git a/api/SetPVPRoles.lua b/api/SetPVPRoles.lua new file mode 100644 index 0000000..8bd5662 --- /dev/null +++ b/api/SetPVPRoles.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetPVPRoles() end \ No newline at end of file diff --git a/api/SetPartyAssignment.lua b/api/SetPartyAssignment.lua new file mode 100644 index 0000000..c2f2129 --- /dev/null +++ b/api/SetPartyAssignment.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param assignment MAINTANK +---@param MAINASSIST +---@param MAINTANK +---@param unit string +---@param name string +---@param exactMatch boolean +---Assigns a group role to a member of the player's party or raid +function SetPartyAssignment(assignment, MAINASSIST, MAINTANK, unit, name, exactMatch) end \ No newline at end of file diff --git a/api/SetPendingReportPetTarget.lua b/api/SetPendingReportPetTarget.lua new file mode 100644 index 0000000..b23a966 --- /dev/null +++ b/api/SetPendingReportPetTarget.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetPendingReportPetTarget() end \ No newline at end of file diff --git a/api/SetPendingReportTarget.lua b/api/SetPendingReportTarget.lua new file mode 100644 index 0000000..88739a8 --- /dev/null +++ b/api/SetPendingReportTarget.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---Sets the target for a yet-to-be-made report.. Used in the stock UI when the "Report player" button is clicked on a unit frame as the report reason form still has to be filled out and the unit associated with the unitID could change before it is submitted. +function SetPendingReportTarget(unit) end \ No newline at end of file diff --git a/api/SetPetSlot.lua b/api/SetPetSlot.lua new file mode 100644 index 0000000..8c5c2b0 --- /dev/null +++ b/api/SetPetSlot.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetPetSlot() end \ No newline at end of file diff --git a/api/SetPetStablePaperdoll.lua b/api/SetPetStablePaperdoll.lua new file mode 100644 index 0000000..de2cb5d --- /dev/null +++ b/api/SetPetStablePaperdoll.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param model table +---Sets the given Model to show the selected stabled pet +function SetPetStablePaperdoll(model) end \ No newline at end of file diff --git a/api/SetPortraitTexture.lua b/api/SetPortraitTexture.lua new file mode 100644 index 0000000..7b3e2f0 --- /dev/null +++ b/api/SetPortraitTexture.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param texture table +---@param unit string +---Sets a Texture object to show a portrait of a unit. Causes the client to render a view of the unit's model from a standard perspective into a circular 2D image and display it in the given Texture object. +function SetPortraitTexture(texture, unit) end \ No newline at end of file diff --git a/api/SetPortraitToTexture.lua b/api/SetPortraitToTexture.lua new file mode 100644 index 0000000..ffc43cf --- /dev/null +++ b/api/SetPortraitToTexture.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param frameName string +---@param texturePath string +---Sets a Texture object to display an arbitrary texture, altering it to fit a circular frame. Used in the default UI to display square textures (such as item icons) within the circular "portrait" frames used in many default UI elements. Caveat: The texture must be of the BLP format. +function SetPortraitToTexture(frameName, texturePath) end \ No newline at end of file diff --git a/api/SetRaidDifficultyID.lua b/api/SetRaidDifficultyID.lua new file mode 100644 index 0000000..a1838e3 --- /dev/null +++ b/api/SetRaidDifficultyID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetRaidDifficultyID() end \ No newline at end of file diff --git a/api/SetRaidProfileOption.lua b/api/SetRaidProfileOption.lua new file mode 100644 index 0000000..47810d5 --- /dev/null +++ b/api/SetRaidProfileOption.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetRaidProfileOption() end \ No newline at end of file diff --git a/api/SetRaidProfileSavedPosition.lua b/api/SetRaidProfileSavedPosition.lua new file mode 100644 index 0000000..1c82414 --- /dev/null +++ b/api/SetRaidProfileSavedPosition.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetRaidProfileSavedPosition() end \ No newline at end of file diff --git a/api/SetRaidSubgroup.lua b/api/SetRaidSubgroup.lua new file mode 100644 index 0000000..b3af6ff --- /dev/null +++ b/api/SetRaidSubgroup.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param subgroup number +---Moves a raid member to a non-full raid subgroup. Only has effect if the player is the raid leader or a raid assistant. To put a member into a full subgroup (switching places with a member of that group), see SwapRaidSubgroup(). +function SetRaidSubgroup(index, subgroup) end \ No newline at end of file diff --git a/api/SetRaidTarget.lua b/api/SetRaidTarget.lua new file mode 100644 index 0000000..e17979f --- /dev/null +++ b/api/SetRaidTarget.lua @@ -0,0 +1,16 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@param index 8 +---@param 0 +---@param 1 +---@param 2 +---@param 3 +---@param 4 +---@param 5 +---@param 6 +---@param 7 +---@param 8 +---Puts a raid target marker on a unit +function SetRaidTarget(unit, name, index, 0, 1, 2, 3, 4, 5, 6, 7, 8) end \ No newline at end of file diff --git a/api/SetRaidTargetProtected.lua b/api/SetRaidTargetProtected.lua new file mode 100644 index 0000000..ae8aa1f --- /dev/null +++ b/api/SetRaidTargetProtected.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetRaidTargetProtected() end \ No newline at end of file diff --git a/api/SetRecruitingGuildSelection.lua b/api/SetRecruitingGuildSelection.lua new file mode 100644 index 0000000..5207008 --- /dev/null +++ b/api/SetRecruitingGuildSelection.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetRecruitingGuildSelection() end \ No newline at end of file diff --git a/api/SetSavedInstanceExtend.lua b/api/SetSavedInstanceExtend.lua new file mode 100644 index 0000000..c64c7e8 --- /dev/null +++ b/api/SetSavedInstanceExtend.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetSavedInstanceExtend() end \ No newline at end of file diff --git a/api/SetScreenResolution.lua b/api/SetScreenResolution.lua new file mode 100644 index 0000000..1089651 --- /dev/null +++ b/api/SetScreenResolution.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Changes the screen resolution +function SetScreenResolution(index) end \ No newline at end of file diff --git a/api/SetSelectedArtifact.lua b/api/SetSelectedArtifact.lua new file mode 100644 index 0000000..fb34767 --- /dev/null +++ b/api/SetSelectedArtifact.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetSelectedArtifact() end \ No newline at end of file diff --git a/api/SetSelectedAuctionItem.lua b/api/SetSelectedAuctionItem.lua new file mode 100644 index 0000000..8bb9fc8 --- /dev/null +++ b/api/SetSelectedAuctionItem.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param list owner +---@param bidder +---@param list +---@param owner +---@param index number +---Selects an item in an auction listing. Auction selection is used only for display and internal recordkeeping in the default UI; it has no direct effect on other Auction APIs. +function SetSelectedAuctionItem(list, bidder, list, owner, index) end \ No newline at end of file diff --git a/api/SetSelectedDisplayChannel.lua b/api/SetSelectedDisplayChannel.lua new file mode 100644 index 0000000..8c8c828 --- /dev/null +++ b/api/SetSelectedDisplayChannel.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Selects a channel in the channel list display +function SetSelectedDisplayChannel(index) end \ No newline at end of file diff --git a/api/SetSelectedFaction.lua b/api/SetSelectedFaction.lua new file mode 100644 index 0000000..2bf3834 --- /dev/null +++ b/api/SetSelectedFaction.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Selects a faction in the reputation UI.   Selection has no bearing on other faction-related APIs; this function merely facilitates behaviors of Blizzard's reputation UI. +function SetSelectedFaction(index) end \ No newline at end of file diff --git a/api/SetSelectedFriend.lua b/api/SetSelectedFriend.lua new file mode 100644 index 0000000..5b9118b --- /dev/null +++ b/api/SetSelectedFriend.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Selects a character in the player's friends list. Selection in the Friends list is used only for display in the default UI and has no effect on other Friends list APIs. +function SetSelectedFriend(index) end \ No newline at end of file diff --git a/api/SetSelectedIgnore.lua b/api/SetSelectedIgnore.lua new file mode 100644 index 0000000..d3e59d0 --- /dev/null +++ b/api/SetSelectedIgnore.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Selects a character in the player's ignore list. Selection in the Ignore list is used only for display in the default UI and has no effect on other Ignore list APIs. +function SetSelectedIgnore(index) end \ No newline at end of file diff --git a/api/SetSelectedMute.lua b/api/SetSelectedMute.lua new file mode 100644 index 0000000..610cd62 --- /dev/null +++ b/api/SetSelectedMute.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Selects an entry in the Muted list. Mute list selection is only used for display purposes in the default UI and has no effect on other API functions. +function SetSelectedMute(index) end \ No newline at end of file diff --git a/api/SetSelectedScreenResolutionIndex.lua b/api/SetSelectedScreenResolutionIndex.lua new file mode 100644 index 0000000..2be1652 --- /dev/null +++ b/api/SetSelectedScreenResolutionIndex.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetSelectedScreenResolutionIndex() end \ No newline at end of file diff --git a/api/SetSelectedWarGameType.lua b/api/SetSelectedWarGameType.lua new file mode 100644 index 0000000..985bfe4 --- /dev/null +++ b/api/SetSelectedWarGameType.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetSelectedWarGameType() end \ No newline at end of file diff --git a/api/SetSendMailCOD.lua b/api/SetSendMailCOD.lua new file mode 100644 index 0000000..cf7bf40 --- /dev/null +++ b/api/SetSendMailCOD.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param amount number +---Sets the Cash-On-Delivery cost of the outgoing message. Called in the default UI when clicking its Send button, immediately before sending the mail. +function SetSendMailCOD(amount) end \ No newline at end of file diff --git a/api/SetSendMailMoney.lua b/api/SetSendMailMoney.lua new file mode 100644 index 0000000..583da06 --- /dev/null +++ b/api/SetSendMailMoney.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param amount number +---@return 1nil success +---Sets the amount of money to be sent with the outgoing message. Called in the default UI when clicking its Send button, immediately before sending the mail. Causes an error message if the amount plus postage exceeds the player's total money. +function SetSendMailMoney(amount) end \ No newline at end of file diff --git a/api/SetSendMailShowing.lua b/api/SetSendMailShowing.lua new file mode 100644 index 0000000..f20eaa3 --- /dev/null +++ b/api/SetSendMailShowing.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param enable boolean +---Enables or disables shortcuts for attaching items to outgoing mail. When shortcuts are enabled, UseContainerItem() (i.e. right-click in the default UI's container frames) attaches the item to the outgoing message instead of using it. +function SetSendMailShowing(enable) end \ No newline at end of file diff --git a/api/SetSortBagsRightToLeft.lua b/api/SetSortBagsRightToLeft.lua new file mode 100644 index 0000000..ca0db33 --- /dev/null +++ b/api/SetSortBagsRightToLeft.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetSortBagsRightToLeft() end \ No newline at end of file diff --git a/api/SetSpecialization.lua b/api/SetSpecialization.lua new file mode 100644 index 0000000..6b141a9 --- /dev/null +++ b/api/SetSpecialization.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetSpecialization() end \ No newline at end of file diff --git a/api/SetSpellbookPetAction.lua b/api/SetSpellbookPetAction.lua new file mode 100644 index 0000000..be4020e --- /dev/null +++ b/api/SetSpellbookPetAction.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetSpellbookPetAction() end \ No newline at end of file diff --git a/api/SetSuperTrackedQuestID.lua b/api/SetSuperTrackedQuestID.lua new file mode 100644 index 0000000..0880a53 --- /dev/null +++ b/api/SetSuperTrackedQuestID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetSuperTrackedQuestID() end \ No newline at end of file diff --git a/api/SetTaxiBenchmarkMode.lua b/api/SetTaxiBenchmarkMode.lua new file mode 100644 index 0000000..00eff28 --- /dev/null +++ b/api/SetTaxiBenchmarkMode.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param arg string +---Enables or disables flight path benchmark mode. When benchmark mode is enabled, the next taxi flight the player takes will behave differently: camera movement is disabled and players/creatures/objects below the flight path will not be shown (allowing for consistent test conditions). After the flight, framerate statistics will be printed in the chat window and benchmark mode will be automatically disabled. +function SetTaxiBenchmarkMode(arg) end \ No newline at end of file diff --git a/api/SetTaxiMap.lua b/api/SetTaxiMap.lua new file mode 100644 index 0000000..49ae0ec --- /dev/null +++ b/api/SetTaxiMap.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param texture table +---Sets a Texture object to show the appropriate flight map texture. Only has effect while interacting with a flight master (i.e. between the TAXIMAP_OPENED and TAXIMAP_CLOSED events). +function SetTaxiMap(texture) end \ No newline at end of file diff --git a/api/SetTracking.lua b/api/SetTracking.lua new file mode 100644 index 0000000..5627239 --- /dev/null +++ b/api/SetTracking.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param enabled boolean +---Enables a given minimap object/unit tracking ability +function SetTracking(index, enabled) end \ No newline at end of file diff --git a/api/SetTradeCurrency.lua b/api/SetTradeCurrency.lua new file mode 100644 index 0000000..94282a8 --- /dev/null +++ b/api/SetTradeCurrency.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetTradeCurrency() end \ No newline at end of file diff --git a/api/SetTradeMoney.lua b/api/SetTradeMoney.lua new file mode 100644 index 0000000..99a1918 --- /dev/null +++ b/api/SetTradeMoney.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param amount number +---Offers an amount of money for trade +function SetTradeMoney(amount) end \ No newline at end of file diff --git a/api/SetTradeSkillCategoryFilter.lua b/api/SetTradeSkillCategoryFilter.lua new file mode 100644 index 0000000..bcbe120 --- /dev/null +++ b/api/SetTradeSkillCategoryFilter.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Filters the trade skill listing by subclass of items produced +function SetTradeSkillCategoryFilter(index) end \ No newline at end of file diff --git a/api/SetTradeSkillInvSlotFilter.lua b/api/SetTradeSkillInvSlotFilter.lua new file mode 100644 index 0000000..3c861e8 --- /dev/null +++ b/api/SetTradeSkillInvSlotFilter.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param enable number +---@param exclusive 1nil +---Filters the trade skill listing by equipment slot of items produced +function SetTradeSkillInvSlotFilter(index, enable, exclusive) end \ No newline at end of file diff --git a/api/SetTradeSkillItemLevelFilter.lua b/api/SetTradeSkillItemLevelFilter.lua new file mode 100644 index 0000000..67d6499 --- /dev/null +++ b/api/SetTradeSkillItemLevelFilter.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param minLevel number +---@param maxLevel number +---Filters the trade skill listing by required level of items produced +function SetTradeSkillItemLevelFilter(minLevel, maxLevel) end \ No newline at end of file diff --git a/api/SetTradeSkillItemNameFilter.lua b/api/SetTradeSkillItemNameFilter.lua new file mode 100644 index 0000000..a17e9ac --- /dev/null +++ b/api/SetTradeSkillItemNameFilter.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param text string +---Filters the trade skill listing by name of recipe, item produced, or reagents. Uses a substring (not exact-match) search: e.g. for a Scribe, the search string "doc" might filter the list to show only Certificate of Ownership because it matches the word "documentation" in that item's tooltip; a search for "stam" will match all items providing a Stamina bonus. +function SetTradeSkillItemNameFilter(text) end \ No newline at end of file diff --git a/api/SetTradeSkillRepeatCount.lua b/api/SetTradeSkillRepeatCount.lua new file mode 100644 index 0000000..8abf7ac --- /dev/null +++ b/api/SetTradeSkillRepeatCount.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SetTradeSkillRepeatCount() end \ No newline at end of file diff --git a/api/SetTrainerServiceTypeFilter.lua b/api/SetTrainerServiceTypeFilter.lua new file mode 100644 index 0000000..083fa98 --- /dev/null +++ b/api/SetTrainerServiceTypeFilter.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param type used +---@param available +---@param unavailable +---@param used +---@param enable number +---@param exclusive 1nil +---Filters the trainer service listing by service status +function SetTrainerServiceTypeFilter(type, available, unavailable, used, enable, exclusive) end \ No newline at end of file diff --git a/api/SetUIVisibility.lua b/api/SetUIVisibility.lua new file mode 100644 index 0000000..4a3a1a2 --- /dev/null +++ b/api/SetUIVisibility.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param visible boolean +---Enables or disables display of UI elements in the 3-D world. Applies only to 2-D UI elements displayed in the 3-D world: nameplates and raid target icons (skull, circle, square, etc). Does not directly control nameplates and target icons -- only affects whether they are displayed (see the nameplateShowEnemies/nameplateShowFriends CVars and SetRaidTarget functions for direct control). Does not apply to 3-D UI elements such as the selection circle, area-effect targeting indicator, vehicle weapon aim indicator, etc. +function SetUIVisibility(visible) end \ No newline at end of file diff --git a/api/SetView.lua b/api/SetView.lua new file mode 100644 index 0000000..85224fb --- /dev/null +++ b/api/SetView.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Moves the camera to a saved camera setting. There are five "slots" for saved camera settings, indexed 1-5. These views can be set and accessed directly using SaveView() and SetView(), and cycled through using NextView() and PrevView(). +function SetView(index) end \ No newline at end of file diff --git a/api/SetWatchedFactionIndex.lua b/api/SetWatchedFactionIndex.lua new file mode 100644 index 0000000..6eb68cd --- /dev/null +++ b/api/SetWatchedFactionIndex.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Makes a faction the "watched" faction (displayed on the XP bar in the default UI) +function SetWatchedFactionIndex(index) end \ No newline at end of file diff --git a/api/SetWhoToUI.lua b/api/SetWhoToUI.lua new file mode 100644 index 0000000..5bed162 --- /dev/null +++ b/api/SetWhoToUI.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param state WHO_LIST_UPDATE +---@param 0 WHO_LIST_UPDATE +---@param 1 WHO_LIST_UPDATE +---Changes the delivery method for results from SendWho() queries. In the default UI, results delivered in CHAT_MSG_SYSTEM are printed in the main chat window; results delivered in a WHO_LIST_UPDATE event cause the FriendsFrame to be shown, displaying the results in its "Who" tab. +function SetWhoToUI(state, 0, 1) end \ No newline at end of file diff --git a/api/SetupFullscreenScale.lua b/api/SetupFullscreenScale.lua new file mode 100644 index 0000000..d7e7fa2 --- /dev/null +++ b/api/SetupFullscreenScale.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param frame table +---Sizes a frame to take up the entire screen regardless of screen resolution +function SetupFullscreenScale(frame) end \ No newline at end of file diff --git a/api/ShouldHideTalentsTab.lua b/api/ShouldHideTalentsTab.lua new file mode 100644 index 0000000..d2c1d5f --- /dev/null +++ b/api/ShouldHideTalentsTab.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ShouldHideTalentsTab() end \ No newline at end of file diff --git a/api/ShowAccountAchievements.lua b/api/ShowAccountAchievements.lua new file mode 100644 index 0000000..9a309b7 --- /dev/null +++ b/api/ShowAccountAchievements.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param show 1nil +---Enables or disables the display of only character achievements to others. This is when people inspect you or use the Battle.net website or mobile app. +function ShowAccountAchievements(show) end \ No newline at end of file diff --git a/api/ShowBuybackSellCursor.lua b/api/ShowBuybackSellCursor.lua new file mode 100644 index 0000000..b05bd50 --- /dev/null +++ b/api/ShowBuybackSellCursor.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Changes the cursor to prepare for repurchasing an item recently sold to a vendor. Only changes the cursor image and mode if the given index contains an item. +function ShowBuybackSellCursor(index) end \ No newline at end of file diff --git a/api/ShowCloak.lua b/api/ShowCloak.lua new file mode 100644 index 0000000..ae37e82 --- /dev/null +++ b/api/ShowCloak.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param show 1nil +---Enables or disables display of the player's cloak. Only affects the player's appearance; does not change the other effects of having the cloak equipped. Determines not only the appearance of the player character on the local client, but the way other players see the character as well. +function ShowCloak(show) end \ No newline at end of file diff --git a/api/ShowContainerSellCursor.lua b/api/ShowContainerSellCursor.lua new file mode 100644 index 0000000..13e12ee --- /dev/null +++ b/api/ShowContainerSellCursor.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param container number +---@param slot number +---Changes the cursor to prepare for selling an item in the player's bags to a vendor. Only changes the cursor image and mode if the given container and slot contain an item. While the cursor is in "sell" mode, UseContainerItem() sells the item to the vendor instead of using it. +function ShowContainerSellCursor(container, slot) end \ No newline at end of file diff --git a/api/ShowFriends.lua b/api/ShowFriends.lua new file mode 100644 index 0000000..2eaa60a --- /dev/null +++ b/api/ShowFriends.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Requests friends/ignore list information from the server. Information is not returned immediately; the FRIENDLIST_UPDATE event fires when data becomes available for use by Friends/Ignore API functions. +function ShowFriends() end \ No newline at end of file diff --git a/api/ShowHelm.lua b/api/ShowHelm.lua new file mode 100644 index 0000000..5442065 --- /dev/null +++ b/api/ShowHelm.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param show 1nil +---Enables or disables display of the player's headgear. Only affects the player's appearance; does not change the other effects of having the headgear equipped. Determines not only the appearance of the player character on the local client, but the way other players see the character as well. +function ShowHelm(show) end \ No newline at end of file diff --git a/api/ShowInventorySellCursor.lua b/api/ShowInventorySellCursor.lua new file mode 100644 index 0000000..fd1a102 --- /dev/null +++ b/api/ShowInventorySellCursor.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---Changes the cursor to prepare for selling an equipped item to a vendor. Only changes the cursor image and mode if the given slot contains an item. (Unlike ShowContainerSellCursor(), does not change the behavior of other functions to enable selling of items. Unused in the default UI.) +function ShowInventorySellCursor(slot) end \ No newline at end of file diff --git a/api/ShowMerchantSellCursor.lua b/api/ShowMerchantSellCursor.lua new file mode 100644 index 0000000..9d93017 --- /dev/null +++ b/api/ShowMerchantSellCursor.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Changes the cursor to prepare for buying an item from a vendor. Only changes the cursor image and mode if the given index contains an item. +function ShowMerchantSellCursor(index) end \ No newline at end of file diff --git a/api/ShowQuestComplete.lua b/api/ShowQuestComplete.lua new file mode 100644 index 0000000..3d4f2a8 --- /dev/null +++ b/api/ShowQuestComplete.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ShowQuestComplete() end \ No newline at end of file diff --git a/api/ShowQuestOffer.lua b/api/ShowQuestOffer.lua new file mode 100644 index 0000000..f101440 --- /dev/null +++ b/api/ShowQuestOffer.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ShowQuestOffer() end \ No newline at end of file diff --git a/api/ShowRepairCursor.lua b/api/ShowRepairCursor.lua new file mode 100644 index 0000000..33623a3 --- /dev/null +++ b/api/ShowRepairCursor.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Puts the cursor in item repair mode. Unlike most other cursor functions, this functions changes the behavior as well as the appearance of the mouse cursor: while repair mode is active, calling PickupContainerItem() or PickupInventoryItem() will attempt to repair the item (and deduct the cost of such from the player's savings) instead of putting it on the cursor. Only has effect while the player is interacting with a vendor which can perform repairs; i.e. between the MERCHANT_SHOW and MERCHANT_CLOSED events, and only if CanMerchantRepair() returns 1. +function ShowRepairCursor() end \ No newline at end of file diff --git a/api/ShowingCloak.lua b/api/ShowingCloak.lua new file mode 100644 index 0000000..c60028a --- /dev/null +++ b/api/ShowingCloak.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isShown +---Returns whether the player's cloak is displayed. Determines not only the appearance of the player character on the local client, but the way other players see the character as well. +function ShowingCloak() end \ No newline at end of file diff --git a/api/ShowingHelm.lua b/api/ShowingHelm.lua new file mode 100644 index 0000000..00461ae --- /dev/null +++ b/api/ShowingHelm.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isShown +---Returns whether the player's headgear is displayed. Determines not only the appearance of the player character on the local client, but the way other players see the character as well. +function ShowingHelm() end \ No newline at end of file diff --git a/api/SignPetition.lua b/api/SignPetition.lua new file mode 100644 index 0000000..d1b74b9 --- /dev/null +++ b/api/SignPetition.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Signs the currently offered petition +function SignPetition() end \ No newline at end of file diff --git a/api/SitStandOrDescendStart.lua b/api/SitStandOrDescendStart.lua new file mode 100644 index 0000000..84b9c05 --- /dev/null +++ b/api/SitStandOrDescendStart.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Causes the player character to sit down if standing and vice versa (or begins descent if swimming or flying). Used by the SITORSTAND binding, which also controls descent when swimming or flying. +function SitStandOrDescendStart() end \ No newline at end of file diff --git a/api/SocketContainerItem.lua b/api/SocketContainerItem.lua new file mode 100644 index 0000000..d9c3cbf --- /dev/null +++ b/api/SocketContainerItem.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param container number +---@param slot number +---Opens an item from the player's bags for socketing +function SocketContainerItem(container, slot) end \ No newline at end of file diff --git a/api/SocketInventoryItem.lua b/api/SocketInventoryItem.lua new file mode 100644 index 0000000..2e49413 --- /dev/null +++ b/api/SocketInventoryItem.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---Opens an equipped item for socketing +function SocketInventoryItem(slot) end \ No newline at end of file diff --git a/api/SocketItemToArtifact.lua b/api/SocketItemToArtifact.lua new file mode 100644 index 0000000..16ce6cb --- /dev/null +++ b/api/SocketItemToArtifact.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SocketItemToArtifact() end \ No newline at end of file diff --git a/api/SolveArtifact.lua b/api/SolveArtifact.lua new file mode 100644 index 0000000..c0aa661 --- /dev/null +++ b/api/SolveArtifact.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Performs the solve archaeology spell. Used to start the cast of a solve archaeology spell on the named fragment type. SolveArtifact() Dwarf, Draenei, Fossil, Night Elf, Nerubian, Orc, Tol'vir, Troll, Vrykul, Mantid,Pandaren, Mogu, Arakkoa, Draenor Clans, Ogre +function SolveArtifact() end \ No newline at end of file diff --git a/api/SortAuctionApplySort.lua b/api/SortAuctionApplySort.lua new file mode 100644 index 0000000..7bad00a --- /dev/null +++ b/api/SortAuctionApplySort.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param list owner +---@param bidder +---@param list +---@param owner +---Applies a set of auction listing sort criteria set via SortAuctionSetSort. Sort criteria are applied server-side, affecting not only the order of items within one "page" of listings but the order in which items are collected into pages. Any currently displayed listings are re-sorted server-side: the AUCTION_ITEM_LIST_UPDATE, AUCTION_BIDDER_LIST_UPDATE, or AUCTION_OWNED_LIST_UPDATE event fires once the re-sorted data is available to the client; listing information can then be retrieved using GetAuctionItemInfo() or other Auction APIs. +function SortAuctionApplySort(list, bidder, list, owner) end \ No newline at end of file diff --git a/api/SortAuctionClearSort.lua b/api/SortAuctionClearSort.lua new file mode 100644 index 0000000..163735d --- /dev/null +++ b/api/SortAuctionClearSort.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param list owner +---@param bidder +---@param list +---@param owner +---Clears any current sorting rules for an auction house listing +function SortAuctionClearSort(list, bidder, list, owner) end \ No newline at end of file diff --git a/api/SortAuctionItems.lua b/api/SortAuctionItems.lua new file mode 100644 index 0000000..88b75f9 --- /dev/null +++ b/api/SortAuctionItems.lua @@ -0,0 +1,19 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param type owner +---@param bidder +---@param list +---@param owner +---@param sort bidder +---@param bid +---@param buyout +---@param duration +---@param level +---@param minbidbuyout +---@param name +---@param quality +---@param quantity +---@param seller owner +---@param status bidder +---Sorts the auction house listing. No longer used in the default UI; see SortAuctionClearSort(), SortAuctionSetSort(), and SortAuctionApplySort() instead. +function SortAuctionItems(type, bidder, list, owner, sort, bid, buyout, duration, level, minbidbuyout, name, quality, quantity, seller, status) end \ No newline at end of file diff --git a/api/SortAuctionSetSort.lua b/api/SortAuctionSetSort.lua new file mode 100644 index 0000000..68da29b --- /dev/null +++ b/api/SortAuctionSetSort.lua @@ -0,0 +1,20 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param list owner +---@param bidder +---@param list +---@param owner +---@param sort bidder +---@param bid +---@param buyout +---@param duration +---@param level +---@param minbidbuyout +---@param name +---@param quality +---@param quantity +---@param seller owner +---@param status bidder +---@param reversed boolean +---Builds a list of sort criteria for auction listings. Has no effect until SortAuctionApplySort(type) is called; thus, this function can be called repeatedly to build a complex set of sort criteria. Sort criteria are applied server-side, affecting not only the order of items within one "page" of listings but the order in which items are collected into pages. Criteria are applied in the order set by this function; i.e. the last criterion set becomes the primary sort criterion (see example). +function SortAuctionSetSort(list, bidder, list, owner, sort, bid, buyout, duration, level, minbidbuyout, name, quality, quantity, seller, status, reversed) end \ No newline at end of file diff --git a/api/SortBags.lua b/api/SortBags.lua new file mode 100644 index 0000000..0f35989 --- /dev/null +++ b/api/SortBags.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SortBags() end \ No newline at end of file diff --git a/api/SortBankBags.lua b/api/SortBankBags.lua new file mode 100644 index 0000000..7a2ac3d --- /dev/null +++ b/api/SortBankBags.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Sorts Bank Bags. Only available while interacting with a banker NPC (i.e. between the BANKFRAMEOPENED and BANKFRAMECLOSED events). +function SortBankBags() end \ No newline at end of file diff --git a/api/SortBattlefieldScoreData.lua b/api/SortBattlefieldScoreData.lua new file mode 100644 index 0000000..994513b --- /dev/null +++ b/api/SortBattlefieldScoreData.lua @@ -0,0 +1,21 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param sortType team +---@param class +---@param cp +---@param damage +---@param deaths +---@param healing +---@param hk +---@param kills +---@param name +---@param stat1 +---@param stat2 +---@param stat3 +---@param stat4 +---@param stat5 +---@param stat6 +---@param stat7 +---@param team +---Sorts the battleground scoreboard. Battleground-specific statistics include flags captured in Warsong Gulch, towers assaulted in Alterac Valley, etc. For the name and icon associated with each statistic, see GetBattlefieldStatInfo(). +function SortBattlefieldScoreData(sortType, class, cp, damage, deaths, healing, hk, kills, name, stat1, stat2, stat3, stat4, stat5, stat6, stat7, team) end \ No newline at end of file diff --git a/api/SortGuildRoster.lua b/api/SortGuildRoster.lua new file mode 100644 index 0000000..c3e27ff --- /dev/null +++ b/api/SortGuildRoster.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param type zone +---@param class +---@param level +---@param name +---@param note +---@param online +---@param rank +---@param zone +---Sorts the guild roster. Sorting repeatedly by the same criterion will reverse the sort order. Previous sorts are reused when a new criterion is applied: to sort by two criteria, sort first by the secondary criterion and then by the primary criterion. +function SortGuildRoster(type, class, level, name, note, online, rank, zone) end \ No newline at end of file diff --git a/api/SortGuildTradeSkill.lua b/api/SortGuildTradeSkill.lua new file mode 100644 index 0000000..65d8deb --- /dev/null +++ b/api/SortGuildTradeSkill.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SortGuildTradeSkill() end \ No newline at end of file diff --git a/api/SortQuestWatches.lua b/api/SortQuestWatches.lua new file mode 100644 index 0000000..0a868d1 --- /dev/null +++ b/api/SortQuestWatches.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean changed +---Sorts the quests listed in the watch frame based on the set criteria +function SortQuestWatches() end \ No newline at end of file diff --git a/api/SortReagentBankBags.lua b/api/SortReagentBankBags.lua new file mode 100644 index 0000000..29b4949 --- /dev/null +++ b/api/SortReagentBankBags.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Sorts Reagent Bank. Only available while interacting with a banker NPC (i.e. between the BANKFRAMEOPENED and BANKFRAMECLOSED events). +function SortReagentBankBags() end \ No newline at end of file diff --git a/api/SortWho.lua b/api/SortWho.lua new file mode 100644 index 0000000..a4c8405 --- /dev/null +++ b/api/SortWho.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param sortType zone +---@param class +---@param guild +---@param level +---@param name +---@param race +---@param zone +---Sorts the Who system query results list. Sorting by the same criterion twice will reverse the sort order. +function SortWho(sortType, class, guild, level, name, race, zone) end \ No newline at end of file diff --git a/api/Sound_ChatSystem_GetInputDriverNameByIndex.lua b/api/Sound_ChatSystem_GetInputDriverNameByIndex.lua new file mode 100644 index 0000000..48c61e2 --- /dev/null +++ b/api/Sound_ChatSystem_GetInputDriverNameByIndex.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Returns the name of the given chat system sound input driver +function Sound_ChatSystem_GetInputDriverNameByIndex(index) end \ No newline at end of file diff --git a/api/Sound_ChatSystem_GetNumInputDrivers.lua b/api/Sound_ChatSystem_GetNumInputDrivers.lua new file mode 100644 index 0000000..4ec10e5 --- /dev/null +++ b/api/Sound_ChatSystem_GetNumInputDrivers.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Returns the number of chat system sound input drivers +function Sound_ChatSystem_GetNumInputDrivers() end \ No newline at end of file diff --git a/api/Sound_ChatSystem_GetNumOutputDrivers.lua b/api/Sound_ChatSystem_GetNumOutputDrivers.lua new file mode 100644 index 0000000..fe89784 --- /dev/null +++ b/api/Sound_ChatSystem_GetNumOutputDrivers.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Returns the number of chat system sound output drivers +function Sound_ChatSystem_GetNumOutputDrivers() end \ No newline at end of file diff --git a/api/Sound_ChatSystem_GetOutputDriverNameByIndex.lua b/api/Sound_ChatSystem_GetOutputDriverNameByIndex.lua new file mode 100644 index 0000000..7337ddf --- /dev/null +++ b/api/Sound_ChatSystem_GetOutputDriverNameByIndex.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Returns the name of the given chat system sound output driver +function Sound_ChatSystem_GetOutputDriverNameByIndex(index) end \ No newline at end of file diff --git a/api/Sound_GameSystem_GetInputDriverNameByIndex.lua b/api/Sound_GameSystem_GetInputDriverNameByIndex.lua new file mode 100644 index 0000000..29ce698 --- /dev/null +++ b/api/Sound_GameSystem_GetInputDriverNameByIndex.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Returns the name of the given game sound input driver +function Sound_GameSystem_GetInputDriverNameByIndex(index) end \ No newline at end of file diff --git a/api/Sound_GameSystem_GetNumInputDrivers.lua b/api/Sound_GameSystem_GetNumInputDrivers.lua new file mode 100644 index 0000000..2d69cb4 --- /dev/null +++ b/api/Sound_GameSystem_GetNumInputDrivers.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Returns the number of game sound input drivers +function Sound_GameSystem_GetNumInputDrivers() end \ No newline at end of file diff --git a/api/Sound_GameSystem_GetNumOutputDrivers.lua b/api/Sound_GameSystem_GetNumOutputDrivers.lua new file mode 100644 index 0000000..1b68aed --- /dev/null +++ b/api/Sound_GameSystem_GetNumOutputDrivers.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Returns the number of game sound output drivers +function Sound_GameSystem_GetNumOutputDrivers() end \ No newline at end of file diff --git a/api/Sound_GameSystem_GetOutputDriverNameByIndex.lua b/api/Sound_GameSystem_GetOutputDriverNameByIndex.lua new file mode 100644 index 0000000..1a31141 --- /dev/null +++ b/api/Sound_GameSystem_GetOutputDriverNameByIndex.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Returns the name of the given game sound output driver +function Sound_GameSystem_GetOutputDriverNameByIndex(index) end \ No newline at end of file diff --git a/api/Sound_GameSystem_RestartSoundSystem.lua b/api/Sound_GameSystem_RestartSoundSystem.lua new file mode 100644 index 0000000..64bb47e --- /dev/null +++ b/api/Sound_GameSystem_RestartSoundSystem.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Restarts the game's sound systems +function Sound_GameSystem_RestartSoundSystem() end \ No newline at end of file diff --git a/api/SpellCanTargetGlyph.lua b/api/SpellCanTargetGlyph.lua new file mode 100644 index 0000000..6eea121 --- /dev/null +++ b/api/SpellCanTargetGlyph.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil canTarget +---Returns whether the spell currently awaiting a target requires a glyph slot to be chosen. Only applies when the player has attempted to cast a spell -- in this case, the "spell" cast when one uses a glyph item -- but the spell requires a target before it can begin casting (i.e. the glowing hand cursor is showing). +function SpellCanTargetGlyph() end \ No newline at end of file diff --git a/api/SpellCanTargetItem.lua b/api/SpellCanTargetItem.lua new file mode 100644 index 0000000..3b135b3 --- /dev/null +++ b/api/SpellCanTargetItem.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil canTarget +---Returns whether the spell currently awaiting a target requires an item to be chosen. Only applies when the player has attempted to cast a spell but the spell requires a target before it can begin casting (i.e. the glowing hand cursor is showing). +function SpellCanTargetItem() end \ No newline at end of file diff --git a/api/SpellCanTargetUnit.lua b/api/SpellCanTargetUnit.lua new file mode 100644 index 0000000..5682450 --- /dev/null +++ b/api/SpellCanTargetUnit.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return 1nil canTarget +---Returns whether the spell currently awaiting a target can target a given unit. Only applies when the player has attempted to cast a spell but the spell requires a target before it can begin casting (i.e. the glowing hand cursor is showing). +function SpellCanTargetUnit(unit, name) end \ No newline at end of file diff --git a/api/SpellCancelQueuedSpell.lua b/api/SpellCancelQueuedSpell.lua new file mode 100644 index 0000000..ca6276e --- /dev/null +++ b/api/SpellCancelQueuedSpell.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SpellCancelQueuedSpell() end \ No newline at end of file diff --git a/api/SpellGetVisibilityInfo.lua b/api/SpellGetVisibilityInfo.lua new file mode 100644 index 0000000..1f33498 --- /dev/null +++ b/api/SpellGetVisibilityInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SpellGetVisibilityInfo() end \ No newline at end of file diff --git a/api/SpellHasRange.lua b/api/SpellHasRange.lua new file mode 100644 index 0000000..7f51ded --- /dev/null +++ b/api/SpellHasRange.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param bookType spell +---@param pet +---@param spell +---@param name string +---@return 1nil hasRange +---Returns whether an item has a range limitation for its use. For example: Shadowbolt can only be used on a unit within a given range of the player; Ritual of Summoning requires a target but has no range restriction; Fel Armor has no target and thus no range restriction. +function SpellHasRange(index, bookType, pet, spell, name) end \ No newline at end of file diff --git a/api/SpellIsAlwaysShown.lua b/api/SpellIsAlwaysShown.lua new file mode 100644 index 0000000..40f150f --- /dev/null +++ b/api/SpellIsAlwaysShown.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SpellIsAlwaysShown() end \ No newline at end of file diff --git a/api/SpellIsSelfBuff.lua b/api/SpellIsSelfBuff.lua new file mode 100644 index 0000000..2b11d9d --- /dev/null +++ b/api/SpellIsSelfBuff.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param spellID integer +---@return boolean state +---Checks if a given spell ID can be cast on the player. Returns a boolean indicating if the spell is a buff that can be applied to the player. +function SpellIsSelfBuff(spellID) end \ No newline at end of file diff --git a/api/SpellIsTargeting.lua b/api/SpellIsTargeting.lua new file mode 100644 index 0000000..1af12f4 --- /dev/null +++ b/api/SpellIsTargeting.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isTargeting +---Returns whether a spell is currently awaiting a target +function SpellIsTargeting() end \ No newline at end of file diff --git a/api/SpellStopCasting.lua b/api/SpellStopCasting.lua new file mode 100644 index 0000000..e528504 --- /dev/null +++ b/api/SpellStopCasting.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Stops casting or targeting the spell in progress +function SpellStopCasting() end \ No newline at end of file diff --git a/api/SpellStopTargeting.lua b/api/SpellStopTargeting.lua new file mode 100644 index 0000000..48a4b09 --- /dev/null +++ b/api/SpellStopTargeting.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Cancels the spell currently awaiting a target. When auto-self cast is not enabled and the player casts a spell that requires a target, the cursor changes to a glowing hand so the user can select a target. This function cancels targeting mode so the player can cast another spell. +function SpellStopTargeting() end \ No newline at end of file diff --git a/api/SpellTargetItem.lua b/api/SpellTargetItem.lua new file mode 100644 index 0000000..55a0c2a --- /dev/null +++ b/api/SpellTargetItem.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemID number +---@param itemName string +---@param itemLink string +---Casts the spell currently awaiting a target on an item. Usable when the player has attempted to cast a spell (e.g. an Enchanting recipe or the "Use:" effect of a sharpening stone or fishing lure) but the spell requires a target before it can begin casting (i.e. the glowing hand cursor is showing). +function SpellTargetItem(itemID, itemName, itemLink) end \ No newline at end of file diff --git a/api/SpellTargetUnit.lua b/api/SpellTargetUnit.lua new file mode 100644 index 0000000..ac473f1 --- /dev/null +++ b/api/SpellTargetUnit.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---Casts the spell currently awaiting a target on a unit +function SpellTargetUnit(unit, name) end \ No newline at end of file diff --git a/api/SplitContainerItem.lua b/api/SplitContainerItem.lua new file mode 100644 index 0000000..18cfc66 --- /dev/null +++ b/api/SplitContainerItem.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param container number +---@param slot number +---@param amount number +---Picks up only part of a stack of items from one of the player's bags or other containers. Has no effect if the given amount is greater than the number of items stacked in the slot. +function SplitContainerItem(container, slot, amount) end \ No newline at end of file diff --git a/api/SplitGuildBankItem.lua b/api/SplitGuildBankItem.lua new file mode 100644 index 0000000..878ef44 --- /dev/null +++ b/api/SplitGuildBankItem.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param tab number +---@param slot number +---@param amount number +---Picks up only part of a stack of items from the guild bank. Has no effect if the given amount is greater than the number of items stacked in the slot. +function SplitGuildBankItem(tab, slot, amount) end \ No newline at end of file diff --git a/api/StartAttack.lua b/api/StartAttack.lua new file mode 100644 index 0000000..7cfb684 --- /dev/null +++ b/api/StartAttack.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---Begins auto-attack against a specified target +function StartAttack(unit, name) end \ No newline at end of file diff --git a/api/StartAuction.lua b/api/StartAuction.lua new file mode 100644 index 0000000..7db5de2 --- /dev/null +++ b/api/StartAuction.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param minBid number +---@param buyoutPrice number +---@param runTime 3 +---@param 1 +---@param 2 +---@param 3 +---@param stackSize number +---@param numStacks number +---Creates an auction for the item currently in the "auction item" slot. Has no effect unless an item has been placed in the Create Auction UI's "auction item" slot (see ClickAuctionSellItemButton()). With patch 3.3.3 the runTime arg was changed from minutes to an index and the stackSize/numStacks args were added for batch posting. +function StartAuction(minBid, buyoutPrice, runTime, 1, 2, 3, stackSize, numStacks) end \ No newline at end of file diff --git a/api/StartDuel.lua b/api/StartDuel.lua new file mode 100644 index 0000000..8029b4f --- /dev/null +++ b/api/StartDuel.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@param exactMatch boolean +---Challenges another player to a duel +function StartDuel(unit, name, exactMatch) end \ No newline at end of file diff --git a/api/StartSpectatorWarGame.lua b/api/StartSpectatorWarGame.lua new file mode 100644 index 0000000..4dc4601 --- /dev/null +++ b/api/StartSpectatorWarGame.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function StartSpectatorWarGame() end \ No newline at end of file diff --git a/api/StartWarGame.lua b/api/StartWarGame.lua new file mode 100644 index 0000000..341c33f --- /dev/null +++ b/api/StartWarGame.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function StartWarGame() end \ No newline at end of file diff --git a/api/StartWarGameByName.lua b/api/StartWarGameByName.lua new file mode 100644 index 0000000..42846f4 --- /dev/null +++ b/api/StartWarGameByName.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function StartWarGameByName() end \ No newline at end of file diff --git a/api/StopAttack.lua b/api/StopAttack.lua new file mode 100644 index 0000000..5e36ec2 --- /dev/null +++ b/api/StopAttack.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Stops auto-attack if active +function StopAttack() end \ No newline at end of file diff --git a/api/StopCinematic.lua b/api/StopCinematic.lua new file mode 100644 index 0000000..9ee96fd --- /dev/null +++ b/api/StopCinematic.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Exits a currently playing in-game cinematic. Applies to in-game-engine cinematics (such as when logging into a new character for the first time), not prerecorded movies. +function StopCinematic() end \ No newline at end of file diff --git a/api/StopMacro.lua b/api/StopMacro.lua new file mode 100644 index 0000000..a19934d --- /dev/null +++ b/api/StopMacro.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Stops execution of a running macro +function StopMacro() end \ No newline at end of file diff --git a/api/StopMusic.lua b/api/StopMusic.lua new file mode 100644 index 0000000..561c79f --- /dev/null +++ b/api/StopMusic.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Stops currently playing in-game music +function StopMusic() end \ No newline at end of file diff --git a/api/StopSound.lua b/api/StopSound.lua new file mode 100644 index 0000000..e811174 --- /dev/null +++ b/api/StopSound.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param soundHandle number +---Stop a playing sound. Stops a sound that has been started with either PlaySound or PlaySoundFile using the handle given as the second return by both functions. +function StopSound(soundHandle) end \ No newline at end of file diff --git a/api/StopTradeSkillRepeat.lua b/api/StopTradeSkillRepeat.lua new file mode 100644 index 0000000..246403c --- /dev/null +++ b/api/StopTradeSkillRepeat.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Cancels repetition of a trade skill recipe. If a recipe is currently being performed, it will continue, but further scheduled repetitions will be canceled. +function StopTradeSkillRepeat() end \ No newline at end of file diff --git a/api/Stopwatch_Clear.lua b/api/Stopwatch_Clear.lua new file mode 100644 index 0000000..ad1980a --- /dev/null +++ b/api/Stopwatch_Clear.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function Stopwatch_Clear() end \ No newline at end of file diff --git a/api/Stopwatch_FinishCountdown.lua b/api/Stopwatch_FinishCountdown.lua new file mode 100644 index 0000000..eedb355 --- /dev/null +++ b/api/Stopwatch_FinishCountdown.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function Stopwatch_FinishCountdown() end \ No newline at end of file diff --git a/api/Stopwatch_IsPlaying.lua b/api/Stopwatch_IsPlaying.lua new file mode 100644 index 0000000..780c193 --- /dev/null +++ b/api/Stopwatch_IsPlaying.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean isPlaying +---Returns True/False if Stop Watch is running. +function Stopwatch_IsPlaying() end \ No newline at end of file diff --git a/api/Stopwatch_Pause.lua b/api/Stopwatch_Pause.lua new file mode 100644 index 0000000..5a6adce --- /dev/null +++ b/api/Stopwatch_Pause.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function Stopwatch_Pause() end \ No newline at end of file diff --git a/api/Stopwatch_Play.lua b/api/Stopwatch_Play.lua new file mode 100644 index 0000000..173b2c9 --- /dev/null +++ b/api/Stopwatch_Play.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function Stopwatch_Play() end \ No newline at end of file diff --git a/api/Stopwatch_StartCountdown.lua b/api/Stopwatch_StartCountdown.lua new file mode 100644 index 0000000..ee3e660 --- /dev/null +++ b/api/Stopwatch_StartCountdown.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param hours integer +---@param minutes integer +---@param seconds integer +---Sets the Stop Watches timer value +function Stopwatch_StartCountdown(hours, minutes, seconds) end \ No newline at end of file diff --git a/api/Stopwatch_Toggle.lua b/api/Stopwatch_Toggle.lua new file mode 100644 index 0000000..9838d6d --- /dev/null +++ b/api/Stopwatch_Toggle.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Toggles visibility of the StopwatchFrame +function Stopwatch_Toggle() end \ No newline at end of file diff --git a/api/StrafeLeftStart.lua b/api/StrafeLeftStart.lua new file mode 100644 index 0000000..3d8ab4c --- /dev/null +++ b/api/StrafeLeftStart.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Begins moving the player character sideways to his or her left +function StrafeLeftStart() end \ No newline at end of file diff --git a/api/StrafeLeftStop.lua b/api/StrafeLeftStop.lua new file mode 100644 index 0000000..4c119cc --- /dev/null +++ b/api/StrafeLeftStop.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends movement initiated by StrafeLeftStart +function StrafeLeftStop() end \ No newline at end of file diff --git a/api/StrafeRightStart.lua b/api/StrafeRightStart.lua new file mode 100644 index 0000000..24052db --- /dev/null +++ b/api/StrafeRightStart.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Begins moving the player character sideways to his or her right +function StrafeRightStart() end \ No newline at end of file diff --git a/api/StrafeRightStop.lua b/api/StrafeRightStop.lua new file mode 100644 index 0000000..ac33f0a --- /dev/null +++ b/api/StrafeRightStop.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends movement initiated by StrafeRightStart +function StrafeRightStop() end \ No newline at end of file diff --git a/api/Stuck.lua b/api/Stuck.lua new file mode 100644 index 0000000..e2f84bc --- /dev/null +++ b/api/Stuck.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Uses the auto-unstuck feature +function Stuck() end \ No newline at end of file diff --git a/api/SubmitRequiredGuildRename.lua b/api/SubmitRequiredGuildRename.lua new file mode 100644 index 0000000..adaba2b --- /dev/null +++ b/api/SubmitRequiredGuildRename.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function SubmitRequiredGuildRename() end \ No newline at end of file diff --git a/api/SummonFriend.lua b/api/SummonFriend.lua new file mode 100644 index 0000000..458b1e4 --- /dev/null +++ b/api/SummonFriend.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param unit string +---Summons a unit whose account is linked to the player's via the Recruit-a-Friend program. Does not instantly teleport the unit -- calling this function begins casting the Summon Friend "spell", and once it completes the unit is prompted to accept or decline the summon. +function SummonFriend(name, unit) end \ No newline at end of file diff --git a/api/SummonRandomCritter.lua b/api/SummonRandomCritter.lua new file mode 100644 index 0000000..433f42d --- /dev/null +++ b/api/SummonRandomCritter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Summons a random critter companion +function SummonRandomCritter() end \ No newline at end of file diff --git a/api/SwapRaidSubgroup.lua b/api/SwapRaidSubgroup.lua new file mode 100644 index 0000000..be76b6c --- /dev/null +++ b/api/SwapRaidSubgroup.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index1 number +---@param index2 number +---Swaps two raid members between subgroups in the raid. Only has effect if the player is the raid leader or a raid assistant. To move a member into a non-full subgroup without switching places with another member, see SetRaidSubgroup(). +function SwapRaidSubgroup(index1, index2) end \ No newline at end of file diff --git a/api/TakeInboxItem.lua b/api/TakeInboxItem.lua new file mode 100644 index 0000000..46849e7 --- /dev/null +++ b/api/TakeInboxItem.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param mailID number +---@param attachmentIndex number +---Retrieves an item attachment from a message in the player's inbox (accepting COD charges if applicable) +function TakeInboxItem(mailID, attachmentIndex) end \ No newline at end of file diff --git a/api/TakeInboxMoney.lua b/api/TakeInboxMoney.lua new file mode 100644 index 0000000..56fb366 --- /dev/null +++ b/api/TakeInboxMoney.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param mailID number +---Retrieves any money attached to a mail in the player's inbox +function TakeInboxMoney(mailID) end \ No newline at end of file diff --git a/api/TakeInboxTextItem.lua b/api/TakeInboxTextItem.lua new file mode 100644 index 0000000..94ae1a4 --- /dev/null +++ b/api/TakeInboxTextItem.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param mailID number +---Requests a copy of a mail's body text as an item. The text of an in-game mail can be retrieved as a readable "Plain Letter" item to store in the player's bags; this function sends a request to the server for this item, causing the standard inventory events to fire as the item is placed into the player's inventory. +function TakeInboxTextItem(mailID) end \ No newline at end of file diff --git a/api/TakeTaxiNode.lua b/api/TakeTaxiNode.lua new file mode 100644 index 0000000..5893f3d --- /dev/null +++ b/api/TakeTaxiNode.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Embarks on a taxi flight to a given destination. Only has effect while interacting with a flight master (i.e. between the TAXIMAP_OPENED and TAXIMAP_CLOSED events). +function TakeTaxiNode(index) end \ No newline at end of file diff --git a/api/TargetDirectionEnemy.lua b/api/TargetDirectionEnemy.lua new file mode 100644 index 0000000..ac654b1 --- /dev/null +++ b/api/TargetDirectionEnemy.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function TargetDirectionEnemy() end \ No newline at end of file diff --git a/api/TargetDirectionFinished.lua b/api/TargetDirectionFinished.lua new file mode 100644 index 0000000..12a069b --- /dev/null +++ b/api/TargetDirectionFinished.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function TargetDirectionFinished() end \ No newline at end of file diff --git a/api/TargetDirectionFriend.lua b/api/TargetDirectionFriend.lua new file mode 100644 index 0000000..7985095 --- /dev/null +++ b/api/TargetDirectionFriend.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function TargetDirectionFriend() end \ No newline at end of file diff --git a/api/TargetLastEnemy.lua b/api/TargetLastEnemy.lua new file mode 100644 index 0000000..418b0aa --- /dev/null +++ b/api/TargetLastEnemy.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Targets the most recently targeted enemy unit +function TargetLastEnemy() end \ No newline at end of file diff --git a/api/TargetLastFriend.lua b/api/TargetLastFriend.lua new file mode 100644 index 0000000..66f929b --- /dev/null +++ b/api/TargetLastFriend.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Targets the most recently targeted friendly unit +function TargetLastFriend() end \ No newline at end of file diff --git a/api/TargetLastTarget.lua b/api/TargetLastTarget.lua new file mode 100644 index 0000000..671e9de --- /dev/null +++ b/api/TargetLastTarget.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Targets the most recently targeted unit +function TargetLastTarget() end \ No newline at end of file diff --git a/api/TargetNearest.lua b/api/TargetNearest.lua new file mode 100644 index 0000000..bfed2b0 --- /dev/null +++ b/api/TargetNearest.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param backward boolean +---Cycles targets through nearest units regardless of reaction/affiliation +function TargetNearest(backward) end \ No newline at end of file diff --git a/api/TargetNearestEnemy.lua b/api/TargetNearestEnemy.lua new file mode 100644 index 0000000..dbf6666 --- /dev/null +++ b/api/TargetNearestEnemy.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param backward boolean +---Cycles your target through the nearest enemy units. This function can only be called once per hardware event. +function TargetNearestEnemy(backward) end \ No newline at end of file diff --git a/api/TargetNearestEnemyPlayer.lua b/api/TargetNearestEnemyPlayer.lua new file mode 100644 index 0000000..8c86235 --- /dev/null +++ b/api/TargetNearestEnemyPlayer.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param backward boolean +---Cycles targets through nearby enemy player units +function TargetNearestEnemyPlayer(backward) end \ No newline at end of file diff --git a/api/TargetNearestFriend.lua b/api/TargetNearestFriend.lua new file mode 100644 index 0000000..4267685 --- /dev/null +++ b/api/TargetNearestFriend.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param backward boolean +---Cycles targets through nearby friendly units +function TargetNearestFriend(backward) end \ No newline at end of file diff --git a/api/TargetNearestFriendPlayer.lua b/api/TargetNearestFriendPlayer.lua new file mode 100644 index 0000000..d1ba633 --- /dev/null +++ b/api/TargetNearestFriendPlayer.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param backward boolean +---Cycles targets through nearby friendly player units +function TargetNearestFriendPlayer(backward) end \ No newline at end of file diff --git a/api/TargetNearestPartyMember.lua b/api/TargetNearestPartyMember.lua new file mode 100644 index 0000000..a98bc8a --- /dev/null +++ b/api/TargetNearestPartyMember.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param backward boolean +---Cycles targets through nearby party members +function TargetNearestPartyMember(backward) end \ No newline at end of file diff --git a/api/TargetNearestRaidMember.lua b/api/TargetNearestRaidMember.lua new file mode 100644 index 0000000..a516bb4 --- /dev/null +++ b/api/TargetNearestRaidMember.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param backward boolean +---Cycles targets through nearby raid members +function TargetNearestRaidMember(backward) end \ No newline at end of file diff --git a/api/TargetTotem.lua b/api/TargetTotem.lua new file mode 100644 index 0000000..94f91b3 --- /dev/null +++ b/api/TargetTotem.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot 4 +---@param 1 +---@param 2 +---@param 3 +---@param 4 +---Targets one of the player's totems (or a Death Knight's ghoul). Totem functions are also used for ghouls summoned by a Death Knight's Raise Dead ability (if the ghoul is not made a controllable pet by the Master of Ghouls talent). +function TargetTotem(slot, 1, 2, 3, 4) end \ No newline at end of file diff --git a/api/TargetUnit.lua b/api/TargetUnit.lua new file mode 100644 index 0000000..f18c14d --- /dev/null +++ b/api/TargetUnit.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@param exactMatch boolean +---Targets a unit. Passing nil is equivalent to calling ClearTarget()). +function TargetUnit(unit, name, exactMatch) end \ No newline at end of file diff --git a/api/TaxiGetDestX.lua b/api/TaxiGetDestX.lua new file mode 100644 index 0000000..6b3e716 --- /dev/null +++ b/api/TaxiGetDestX.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param source number +---@param dest number +---@return number dX +---Returns the horizontal coordinate of a taxi flight's destination node. Used in the default UI to draw lines between nodes; TaxiNodeSetCurrent() should be called first so the client can compute routes. Only returns valid data while interacting with a flight master (i.e. between the TAXIMAP_OPENED and TAXIMAP_CLOSED events). +function TaxiGetDestX(source, dest) end \ No newline at end of file diff --git a/api/TaxiGetDestY.lua b/api/TaxiGetDestY.lua new file mode 100644 index 0000000..9f56784 --- /dev/null +++ b/api/TaxiGetDestY.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param source number +---@param dest number +---@return number dY +---Returns the vertical coordinate of a taxi flight's destination node. Used in the default UI to draw lines between nodes; TaxiNodeSetCurrent() should be called first so the client can compute routes. Only returns valid data while interacting with a flight master (i.e. between the TAXIMAP_OPENED and TAXIMAP_CLOSED events). +function TaxiGetDestY(source, dest) end \ No newline at end of file diff --git a/api/TaxiGetNodeSlot.lua b/api/TaxiGetNodeSlot.lua new file mode 100644 index 0000000..891a6b0 --- /dev/null +++ b/api/TaxiGetNodeSlot.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param hop number +---@param query_start boolean +---@return number index +---Returns the starting/ending point of a chosen segment of a multi-hop taxi flight. Only returns valid data while interacting with a flight master (i.e. between the TAXIMAP_OPENED and TAXIMAP_CLOSED events). Returns 1 for invalid parameters. +function TaxiGetNodeSlot(index, hop, query_start) end \ No newline at end of file diff --git a/api/TaxiGetSrcX.lua b/api/TaxiGetSrcX.lua new file mode 100644 index 0000000..338424c --- /dev/null +++ b/api/TaxiGetSrcX.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param source number +---@param dest number +---@return number sX +---Returns the horizontal coordinate of a taxi flight's source node. Used in the default UI to draw lines between nodes; TaxiNodeSetCurrent() should be called first so the client can compute routes. Only returns valid data while interacting with a flight master (i.e. between the TAXIMAP_OPENED and TAXIMAP_CLOSED events). +function TaxiGetSrcX(source, dest) end \ No newline at end of file diff --git a/api/TaxiGetSrcY.lua b/api/TaxiGetSrcY.lua new file mode 100644 index 0000000..79a4f53 --- /dev/null +++ b/api/TaxiGetSrcY.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param source number +---@param dest number +---@return number sY +---Returns the vertical coordinate of a taxi flight's source node. Used in the default UI to draw lines between nodes; TaxiNodeSetCurrent() should be called first so the client can compute routes. Only returns valid data while interacting with a flight master (i.e. between the TAXIMAP_OPENED and TAXIMAP_CLOSED events). +function TaxiGetSrcY(source, dest) end \ No newline at end of file diff --git a/api/TaxiNodeCost.lua b/api/TaxiNodeCost.lua new file mode 100644 index 0000000..fab3718 --- /dev/null +++ b/api/TaxiNodeCost.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number cost +---Returns the cost to fly to a given taxi node. Only returns valid data while interacting with a flight master (i.e. between the TAXIMAP_OPENED and TAXIMAP_CLOSED events). +function TaxiNodeCost(index) end \ No newline at end of file diff --git a/api/TaxiNodeGetType.lua b/api/TaxiNodeGetType.lua new file mode 100644 index 0000000..f6cd025 --- /dev/null +++ b/api/TaxiNodeGetType.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return REACHABLE type +---@return CURRENT +---@return DISTANT +---@return NONE +---@return REACHABLE +---Returns the type of a flight pont. Only returns valid data while interacting with a flight master (i.e. between the TAXIMAP_OPENED and TAXIMAP_CLOSED events). +function TaxiNodeGetType(index) end \ No newline at end of file diff --git a/api/TaxiNodeName.lua b/api/TaxiNodeName.lua new file mode 100644 index 0000000..22bbc22 --- /dev/null +++ b/api/TaxiNodeName.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return string name +---Returns the name of a flight point. Only returns valid data while interacting with a flight master (i.e. between the TAXIMAP_OPENED and TAXIMAP_CLOSED events). +function TaxiNodeName(index) end \ No newline at end of file diff --git a/api/TaxiNodePosition.lua b/api/TaxiNodePosition.lua new file mode 100644 index 0000000..14eef10 --- /dev/null +++ b/api/TaxiNodePosition.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@return number x +---@return number y +---Returns the position of a flight point on the taxi map. Only returns valid data while interacting with a flight master (i.e. between the TAXIMAP_OPENED and TAXIMAP_CLOSED events). +function TaxiNodePosition(index) end \ No newline at end of file diff --git a/api/TaxiNodeSetCurrent.lua b/api/TaxiNodeSetCurrent.lua new file mode 100644 index 0000000..0e4eefa --- /dev/null +++ b/api/TaxiNodeSetCurrent.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---Sets the "current" flight path node. Used in the default UI when mousing over a node; tells the client to compute the route paths involving the node (see TaxiGetSrcX() et al). +function TaxiNodeSetCurrent(slot) end \ No newline at end of file diff --git a/api/TeleportToDebugObject.lua b/api/TeleportToDebugObject.lua new file mode 100644 index 0000000..c307f1d --- /dev/null +++ b/api/TeleportToDebugObject.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function TeleportToDebugObject() end \ No newline at end of file diff --git a/api/TimeoutResurrect.lua b/api/TimeoutResurrect.lua new file mode 100644 index 0000000..271d121 --- /dev/null +++ b/api/TimeoutResurrect.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function TimeoutResurrect() end \ No newline at end of file diff --git a/api/ToggleAutoRun.lua b/api/ToggleAutoRun.lua new file mode 100644 index 0000000..cde47a4 --- /dev/null +++ b/api/ToggleAutoRun.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Starts or stops the player character automatically moving forward +function ToggleAutoRun() end \ No newline at end of file diff --git a/api/ToggleCollision.lua b/api/ToggleCollision.lua new file mode 100644 index 0000000..47ebe7d --- /dev/null +++ b/api/ToggleCollision.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ToggleCollision() end \ No newline at end of file diff --git a/api/ToggleCollisionDisplay.lua b/api/ToggleCollisionDisplay.lua new file mode 100644 index 0000000..a7cdb85 --- /dev/null +++ b/api/ToggleCollisionDisplay.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ToggleCollisionDisplay() end \ No newline at end of file diff --git a/api/ToggleGlyphFilter.lua b/api/ToggleGlyphFilter.lua new file mode 100644 index 0000000..9b91b10 --- /dev/null +++ b/api/ToggleGlyphFilter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ToggleGlyphFilter() end \ No newline at end of file diff --git a/api/TogglePVP.lua b/api/TogglePVP.lua new file mode 100644 index 0000000..953d03b --- /dev/null +++ b/api/TogglePVP.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Switches the player's desired PvP status. If PvP is currently disabled for the player, it becomes enabled immediately. If PvP is enabled, it will become disabled after five minutes of no PvP activity. +function TogglePVP() end \ No newline at end of file diff --git a/api/TogglePerformancePause.lua b/api/TogglePerformancePause.lua new file mode 100644 index 0000000..4533159 --- /dev/null +++ b/api/TogglePerformancePause.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function TogglePerformancePause() end \ No newline at end of file diff --git a/api/TogglePerformanceValues.lua b/api/TogglePerformanceValues.lua new file mode 100644 index 0000000..40c43f0 --- /dev/null +++ b/api/TogglePerformanceValues.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function TogglePerformanceValues() end \ No newline at end of file diff --git a/api/TogglePetAutocast.lua b/api/TogglePetAutocast.lua new file mode 100644 index 0000000..a5c4c37 --- /dev/null +++ b/api/TogglePetAutocast.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---Turns autocast on or off for a pet action. Turns autocast on if not autocasting and vice versa. +function TogglePetAutocast(index) end \ No newline at end of file diff --git a/api/TogglePlayerBounds.lua b/api/TogglePlayerBounds.lua new file mode 100644 index 0000000..89941e3 --- /dev/null +++ b/api/TogglePlayerBounds.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function TogglePlayerBounds() end \ No newline at end of file diff --git a/api/TogglePortals.lua b/api/TogglePortals.lua new file mode 100644 index 0000000..d283c0d --- /dev/null +++ b/api/TogglePortals.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function TogglePortals() end \ No newline at end of file diff --git a/api/ToggleRun.lua b/api/ToggleRun.lua new file mode 100644 index 0000000..4f5b144 --- /dev/null +++ b/api/ToggleRun.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Switches the character's ground movement mode between running and walking. If running, switches to walking, and vice versa. Has no effect on swimming or flying speed. +function ToggleRun() end \ No newline at end of file diff --git a/api/ToggleSheath.lua b/api/ToggleSheath.lua new file mode 100644 index 0000000..e5ff80a --- /dev/null +++ b/api/ToggleSheath.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Sheaths or unsheaths the player character's hand-held items. Calling repeatedly will cause the player character to draw his or her melee weapons, followed by his or her range weapon, followed by hiding all weapons. +function ToggleSheath() end \ No newline at end of file diff --git a/api/ToggleSpellAutocast.lua b/api/ToggleSpellAutocast.lua new file mode 100644 index 0000000..8715cee --- /dev/null +++ b/api/ToggleSpellAutocast.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param bookType spell +---@param pet +---@param spell +---@param name string +---Enables or disables automatic casting of a spell. Generally only pet spells can be autocast. +function ToggleSpellAutocast(index, bookType, pet, spell, name) end \ No newline at end of file diff --git a/api/ToggleTris.lua b/api/ToggleTris.lua new file mode 100644 index 0000000..2bb50ba --- /dev/null +++ b/api/ToggleTris.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ToggleTris() end \ No newline at end of file diff --git a/api/TradeSkillOnlyShowMakeable.lua b/api/TradeSkillOnlyShowMakeable.lua new file mode 100644 index 0000000..a967ed8 --- /dev/null +++ b/api/TradeSkillOnlyShowMakeable.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param filter boolean +---Filters the trade skill listing by whether the player currently has enough reagents for each recipe +function TradeSkillOnlyShowMakeable(filter) end \ No newline at end of file diff --git a/api/TradeSkillOnlyShowSkillUps.lua b/api/TradeSkillOnlyShowSkillUps.lua new file mode 100644 index 0000000..f82c313 --- /dev/null +++ b/api/TradeSkillOnlyShowSkillUps.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param filter boolean +---Filters the trade skill listing by whether the player can gain skill ranks from each recipe. The default UI does not provide controls for this filter, but it can nonetheless be used to alter the contents of the trade skill recipe listing. +function TradeSkillOnlyShowSkillUps(filter) end \ No newline at end of file diff --git a/api/TriggerTutorial.lua b/api/TriggerTutorial.lua new file mode 100644 index 0000000..5d167fa --- /dev/null +++ b/api/TriggerTutorial.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function TriggerTutorial() end \ No newline at end of file diff --git a/api/TurnInGuildCharter.lua b/api/TurnInGuildCharter.lua new file mode 100644 index 0000000..3086ede --- /dev/null +++ b/api/TurnInGuildCharter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Turns in a completed guild charter. Usable if the player is interacting with a guild registrar (i.e. between the GUILD_REGISTRAR_SHOW and GUILD_REGISTRAR_CLOSED events). +function TurnInGuildCharter() end \ No newline at end of file diff --git a/api/TurnLeftStart.lua b/api/TurnLeftStart.lua new file mode 100644 index 0000000..735a377 --- /dev/null +++ b/api/TurnLeftStart.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Begins turning the player character to the left. "Left" here is relative to the player's facing; i.e. if looking down at the character from above, he or she turns counter-clockwise. Used by the TURNLEFT binding. +function TurnLeftStart() end \ No newline at end of file diff --git a/api/TurnLeftStop.lua b/api/TurnLeftStop.lua new file mode 100644 index 0000000..ba1e602 --- /dev/null +++ b/api/TurnLeftStop.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends movement initiated by TurnLeftStart +function TurnLeftStop() end \ No newline at end of file diff --git a/api/TurnOrActionStart.lua b/api/TurnOrActionStart.lua new file mode 100644 index 0000000..19030ad --- /dev/null +++ b/api/TurnOrActionStart.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Begins character steering or interaction (equivalent to right-clicking in the 3-D world). After calling this function (i.e. while the right mouse button is held), cursor movement rotates (or steers) the player character, altering yaw (facing) and/or pitch (vertical movement angle) as well as camera position. Final results vary by context and are determined when calling TurnOrActionStop() (i.e. releasing the right mouse button). Used by the TURNORACTION binding (not customizable in the default UI), which is bound to the right mouse button by default. +function TurnOrActionStart() end \ No newline at end of file diff --git a/api/TurnOrActionStop.lua b/api/TurnOrActionStop.lua new file mode 100644 index 0000000..b771552 --- /dev/null +++ b/api/TurnOrActionStop.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends action initiated by TurnOrActionStart. After calling this function (i.e. releasing the right mouse button), character steering stops and normal cursor movement resumes. If the cursor has not moved significantly since calling TurnOrActionStart() (i.e. pressing the right mouse button), results vary by context: if the cursor is over a nearby unit, interacts with (or attacks) that unit, making it the player's target. if the cursor is over a nearby interactable world object (e.g. mailbox, treasure chest, or quest object), interacts with (or uses) that object. if the cursor is over a faraway unit or world object and the "Click-to-Move" option is enabled (i.e. the "autointeract" CVar is "1"), attempts to move the player character to the unit/object and interact with it once nearby. if the cursor is over a faraway world object and the "Click-to-Move" option is disabled, fires a UI_ERROR_MESSAGE event indicating the player is too far away to interact with the object. otherwise, does nothing. Used by the TURNORACTION binding (not customizable in the default UI), which is bound to the right mouse button by default. +function TurnOrActionStop() end \ No newline at end of file diff --git a/api/TurnRightStart.lua b/api/TurnRightStart.lua new file mode 100644 index 0000000..1ea2205 --- /dev/null +++ b/api/TurnRightStart.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Begins turning the player character to the right. "Right" here is relative to the player's facing; i.e. if looking down at the character from above, he or she turns clockwise. Used by the TURNRIGHT binding. +function TurnRightStart() end \ No newline at end of file diff --git a/api/TurnRightStop.lua b/api/TurnRightStop.lua new file mode 100644 index 0000000..a307f47 --- /dev/null +++ b/api/TurnRightStop.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Ends movement initiated by TurnRightStart +function TurnRightStop() end \ No newline at end of file diff --git a/api/UninviteUnit.lua b/api/UninviteUnit.lua new file mode 100644 index 0000000..e8a6152 --- /dev/null +++ b/api/UninviteUnit.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param reason string +---Removes a character from the player's party or raid. Only works if the player is the party leader, raid leader, or raid assistant. Also used by the Looking For Group tool to vote kick players. This is what the "reason" argument is used for. +function UninviteUnit(name, reason) end \ No newline at end of file diff --git a/api/UnitAffectingCombat.lua b/api/UnitAffectingCombat.lua new file mode 100644 index 0000000..7934d39 --- /dev/null +++ b/api/UnitAffectingCombat.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return 1nil inCombat +---Returns whether a unit is currently in combat +function UnitAffectingCombat(unit) end \ No newline at end of file diff --git a/api/UnitAlternatePowerCounterInfo.lua b/api/UnitAlternatePowerCounterInfo.lua new file mode 100644 index 0000000..f337df2 --- /dev/null +++ b/api/UnitAlternatePowerCounterInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitAlternatePowerCounterInfo() end \ No newline at end of file diff --git a/api/UnitAlternatePowerInfo.lua b/api/UnitAlternatePowerInfo.lua new file mode 100644 index 0000000..5140856 --- /dev/null +++ b/api/UnitAlternatePowerInfo.lua @@ -0,0 +1,19 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return number barType +---@return number minPower +---@return number startInset +---@return number endInset +---@return boolean smooth +---@return boolean hideFromOthers +---@return boolean showOnRaid +---@return boolean opaqueSpark +---@return boolean opaqueFlash +---@return string powerName +---@return string powerTooltip +---@return string costString +---@return number barID +---Returns information about a unit's alternate power display +function UnitAlternatePowerInfo(unit, name) end \ No newline at end of file diff --git a/api/UnitAlternatePowerTextureInfo.lua b/api/UnitAlternatePowerTextureInfo.lua new file mode 100644 index 0000000..471ce53 --- /dev/null +++ b/api/UnitAlternatePowerTextureInfo.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param textureIndex number +---@return string texture +---@return number r +---@return number g +---@return number b +---@return number a +---Retrieves textures and colors for the parts of the alternate power indicator. Retrieves information on how to render the alternate power indicator. Note that the color can be 1,1,1,1 even if the bar appears to be colored because the color is baked into the texture. +function UnitAlternatePowerTextureInfo(unit, textureIndex) end \ No newline at end of file diff --git a/api/UnitArmor.lua b/api/UnitArmor.lua new file mode 100644 index 0000000..6796e80 --- /dev/null +++ b/api/UnitArmor.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return number base +---@return number effectiveArmor +---@return number armor +---@return number posBuff +---@return number negBuff +---Returns the player's or pet's armor value +function UnitArmor(unit) end \ No newline at end of file diff --git a/api/UnitAttackBothHands.lua b/api/UnitAttackBothHands.lua new file mode 100644 index 0000000..524d752 --- /dev/null +++ b/api/UnitAttackBothHands.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return number mainHandAttackBase +---@return number mainHandAttackMod +---@return number offHandHandAttackBase +---@return number offHandAttackMod +---Returns information about the player's or pet's weapon skill +function UnitAttackBothHands(unit) end \ No newline at end of file diff --git a/api/UnitAttackPower.lua b/api/UnitAttackPower.lua new file mode 100644 index 0000000..b69b590 --- /dev/null +++ b/api/UnitAttackPower.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return number base +---@return number posBuff +---@return number negBuff +---Returns the player's or pet's melee attack power +function UnitAttackPower(unit) end \ No newline at end of file diff --git a/api/UnitAttackSpeed.lua b/api/UnitAttackSpeed.lua new file mode 100644 index 0000000..8da8fb3 --- /dev/null +++ b/api/UnitAttackSpeed.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return number speed +---@return number offhandSpeed +---Returns information about the unit's melee attack speed +function UnitAttackSpeed(unit) end \ No newline at end of file diff --git a/api/UnitAura.lua b/api/UnitAura.lua new file mode 100644 index 0000000..05a35e3 --- /dev/null +++ b/api/UnitAura.lua @@ -0,0 +1,38 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param index number +---@param name string +---@param rank string +---@param filter RAID +---@param CANCELABLE +---@param HARMFUL +---@param HELPFUL +---@param NOT_CANCELABLE +---@param PLAYER +---@param RAID +---@return string name +---@return string rank +---@return string icon +---@return number count +---@return Poison dispelType +---@return Curse +---@return Disease +---@return Magic +---@return Poison +---@return number duration +---@return number expires +---@return string caster +---@return boolean isStealable +---@return boolean nameplateShowPersonal +---@return number spellID +---@return boolean canApplyAura +---@return boolean isBossDebuff +---@return boolean _ +---@return boolean nameplateShowAll +---@return number timeMod +---@return number value1 +---@return number value2 +---@return number value3 +---Returns information about buffs/debuffs on a unit +function UnitAura(unit, index, name, rank, filter, CANCELABLE, HARMFUL, HELPFUL, NOT_CANCELABLE, PLAYER, RAID) end \ No newline at end of file diff --git a/api/UnitBattlePetLevel.lua b/api/UnitBattlePetLevel.lua new file mode 100644 index 0000000..d1cfc34 --- /dev/null +++ b/api/UnitBattlePetLevel.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitBattlePetLevel() end \ No newline at end of file diff --git a/api/UnitBattlePetSpeciesID.lua b/api/UnitBattlePetSpeciesID.lua new file mode 100644 index 0000000..2a55aa9 --- /dev/null +++ b/api/UnitBattlePetSpeciesID.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitBattlePetSpeciesID() end \ No newline at end of file diff --git a/api/UnitBattlePetType.lua b/api/UnitBattlePetType.lua new file mode 100644 index 0000000..6179c97 --- /dev/null +++ b/api/UnitBattlePetType.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitBattlePetType() end \ No newline at end of file diff --git a/api/UnitBonusArmor.lua b/api/UnitBonusArmor.lua new file mode 100644 index 0000000..d37c7ee --- /dev/null +++ b/api/UnitBonusArmor.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitBonusArmor() end \ No newline at end of file diff --git a/api/UnitBuff.lua b/api/UnitBuff.lua new file mode 100644 index 0000000..a655f13 --- /dev/null +++ b/api/UnitBuff.lua @@ -0,0 +1,36 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param index number +---@param name string +---@param rank string +---@param filter RAID +---@param CANCELABLE +---@param NOT_CANCELABLE +---@param PLAYER +---@param RAID +---@return string name +---@return string rank +---@return string icon +---@return number count +---@return Poison dispelType +---@return Curse +---@return Disease +---@return Magic +---@return Poison +---@return number duration +---@return number expires +---@return string caster +---@return boolean isStealable +---@return boolean nameplateShowPersonal +---@return number spellID +---@return boolean canApplyAura +---@return boolean isBossDebuff +---@return boolean _ +---@return boolean nameplateShowAll +---@return number timeMod +---@return number value1 +---@return number value2 +---@return number value3 +---Returns information about a buff on a unit. This function is an alias for UnitAura() with a built-in HELPFUL filter (which cannot be removed or negated with the HARMFUL filter). +function UnitBuff(unit, index, name, rank, filter, CANCELABLE, NOT_CANCELABLE, PLAYER, RAID) end \ No newline at end of file diff --git a/api/UnitCanAssist.lua b/api/UnitCanAssist.lua new file mode 100644 index 0000000..40aa76e --- /dev/null +++ b/api/UnitCanAssist.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param unit string +---@return 1nil canAssist +---Returns whether one unit can assist another +function UnitCanAssist(unit, unit) end \ No newline at end of file diff --git a/api/UnitCanAttack.lua b/api/UnitCanAttack.lua new file mode 100644 index 0000000..98110f5 --- /dev/null +++ b/api/UnitCanAttack.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param unit string +---@return 1nil canAttack +---Returns whether one unit can attack another +function UnitCanAttack(unit, unit) end \ No newline at end of file diff --git a/api/UnitCanCooperate.lua b/api/UnitCanCooperate.lua new file mode 100644 index 0000000..ff6d4f1 --- /dev/null +++ b/api/UnitCanCooperate.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param unit string +---@return 1nil canCooperate +---Returns whether two units can cooperate. Two units are considered to be able to cooperate with each other if they are of the same faction and are both players. +function UnitCanCooperate(unit, unit) end \ No newline at end of file diff --git a/api/UnitCanPetBattle.lua b/api/UnitCanPetBattle.lua new file mode 100644 index 0000000..256d7e0 --- /dev/null +++ b/api/UnitCanPetBattle.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitCanPetBattle() end \ No newline at end of file diff --git a/api/UnitCastingInfo.lua b/api/UnitCastingInfo.lua new file mode 100644 index 0000000..845e340 --- /dev/null +++ b/api/UnitCastingInfo.lua @@ -0,0 +1,14 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return string name +---@return string subText +---@return string text +---@return string texture +---@return number startTime +---@return number endTime +---@return 1nil isTradeSkill +---@return number castID +---@return 1nil notInterruptible +---Returns information about the spell a unit is currently casting +function UnitCastingInfo(unit) end \ No newline at end of file diff --git a/api/UnitChannelInfo.lua b/api/UnitChannelInfo.lua new file mode 100644 index 0000000..f8c22a5 --- /dev/null +++ b/api/UnitChannelInfo.lua @@ -0,0 +1,13 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return string name +---@return string subText +---@return string text +---@return string texture +---@return number startTime +---@return number endTime +---@return 1nil isTradeSkill +---@return boolean notInterruptible +---Returns information about the spell a unit is currently channeling +function UnitChannelInfo(unit) end \ No newline at end of file diff --git a/api/UnitClass.lua b/api/UnitClass.lua new file mode 100644 index 0000000..371c6eb --- /dev/null +++ b/api/UnitClass.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return string class +---@return string classFileName +---@return number classIndex +---Returns a unit's class. The second return (classFileName) can be used for locale-independent verification of a unit's class, or to look up class-related data in various global tables: RAID_CLASS_COLORS provides a standard color for each class (as seen in the default who, guild, calendar, and raid UIs) CLASS_ICON_TCOORDS provides coordinates to locate each class' icon within the "Interface\Glues\CharacterCreate\UI-CharacterCreate-Classes" texture For non-player units, the first return (class) will be the unit's name; to always get a localized class name regardless of unit type, use UnitClassBase instead. +function UnitClass(unit, name) end \ No newline at end of file diff --git a/api/UnitClassBase.lua b/api/UnitClassBase.lua new file mode 100644 index 0000000..2a3ea17 --- /dev/null +++ b/api/UnitClassBase.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return string class +---@return string classFileName +---Returns a unit's class. The second return (classFileName) can be used for locale-independent verification of a unit's class, or to look up class-related data in various global tables: RAID_CLASS_COLORS provides a standard color for each class (as seen in the default who, guild, calendar, and raid UIs) CLASS_ICON_TCOORDS provides coordinates to locate each class' icon within the "Interface\Glues\CharacterCreate\UI-CharacterCreate-Classes" texture Unlike UnitClass, this function returns the same values for NPCs as for players. +function UnitClassBase(unit, name) end \ No newline at end of file diff --git a/api/UnitClassification.lua b/api/UnitClassification.lua new file mode 100644 index 0000000..e7233cf --- /dev/null +++ b/api/UnitClassification.lua @@ -0,0 +1,13 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return worldboss classification +---@return elite +---@return minus +---@return normal +---@return rare +---@return rareelite +---@return trivial +---@return worldboss +---Returns a unit's classification +function UnitClassification(unit) end \ No newline at end of file diff --git a/api/UnitControllingVehicle.lua b/api/UnitControllingVehicle.lua new file mode 100644 index 0000000..26aa35e --- /dev/null +++ b/api/UnitControllingVehicle.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return boolean isControlling +---Returns whether a unit is controlling a vehicle +function UnitControllingVehicle(unit, name) end \ No newline at end of file diff --git a/api/UnitCreatureFamily.lua b/api/UnitCreatureFamily.lua new file mode 100644 index 0000000..7d9fb31 --- /dev/null +++ b/api/UnitCreatureFamily.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return string family +---Returns the creature family of the unit. Applies only to beasts of the kinds that can be taken as Hunter pets (e.g. cats, worms, and ravagers but not zhevras, talbuks and pterrordax), demons of the types that can be summoned by Warlocks (e.g. imps and felguards, but not demons that require enslaving such as infernals and doomguards or world demons such as pit lords and armored voidwalkers) and Death Knight's pets (ghouls). +function UnitCreatureFamily(unit) end \ No newline at end of file diff --git a/api/UnitCreatureType.lua b/api/UnitCreatureType.lua new file mode 100644 index 0000000..591aa7a --- /dev/null +++ b/api/UnitCreatureType.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return string type +---Returns the creature type of a unit. Note that some creatures have no type (e.g. slimes). +function UnitCreatureType(unit) end \ No newline at end of file diff --git a/api/UnitDamage.lua b/api/UnitDamage.lua new file mode 100644 index 0000000..32eacfa --- /dev/null +++ b/api/UnitDamage.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return number minDamage +---@return number maxDamage +---@return number minOffHandDamage +---@return number maxOffHandDamage +---@return number physicalBonusPos +---@return number physicalBonusNeg +---@return number percent +---Returns information about the player's or pet's melee attack damage +function UnitDamage(unit) end \ No newline at end of file diff --git a/api/UnitDebuff.lua b/api/UnitDebuff.lua new file mode 100644 index 0000000..0901670 --- /dev/null +++ b/api/UnitDebuff.lua @@ -0,0 +1,36 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param index number +---@param name string +---@param rank string +---@param filter RAID +---@param CANCELABLE +---@param NOT_CANCELABLE +---@param PLAYER +---@param RAID +---@return string name +---@return string rank +---@return string icon +---@return number count +---@return Poison dispelType +---@return Curse +---@return Disease +---@return Magic +---@return Poison +---@return number duration +---@return number expires +---@return string caster +---@return boolean isStealable +---@return boolean nameplateShowPersonal +---@return number spellID +---@return boolean canApplyAura +---@return boolean isBossDebuff +---@return boolean _ +---@return boolean nameplateShowAll +---@return number timeMod +---@return number value1 +---@return number value2 +---@return number value3 +---Returns information about a debuff on a unit. This function is an alias for UnitAura() with a built-in HARMFUL filter (which cannot be removed or negated with the HELPFUL filter). +function UnitDebuff(unit, index, name, rank, filter, CANCELABLE, NOT_CANCELABLE, PLAYER, RAID) end \ No newline at end of file diff --git a/api/UnitDefense.lua b/api/UnitDefense.lua new file mode 100644 index 0000000..48d19b5 --- /dev/null +++ b/api/UnitDefense.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return number base +---@return number modifier +---Returns the player's or pet's Defense skill +function UnitDefense(unit) end \ No newline at end of file diff --git a/api/UnitDetailedThreatSituation.lua b/api/UnitDetailedThreatSituation.lua new file mode 100644 index 0000000..dbffd8c --- /dev/null +++ b/api/UnitDetailedThreatSituation.lua @@ -0,0 +1,16 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit unitid +---@param name string +---@param mobUnit unitid +---@return 1nil isTanking +---@return mobUnit status +---@return 0 +---@return 1 +---@return mobUnit 2 +---@return mobUnit 3 +---@return number scaledPercent +---@return number rawPercent +---@return number threatValue +---Returns detailed information about the threat status of one unit against another. The different values returned by this function reflect the complexity of NPC threat management: Raw threat roughly equates to the amount of damage a unit has caused to the NPC plus the amount of healing the unit has performed in the NPC's presence. (Each quantity that goes into this sum may be modified, however; such as by a paladin's Righteous Fury self-buff, a priest's Silent Resolve talent, or a player whose cloak is enchanted with Subtlety.) Generally, whichever unit has the highest raw threat against an NPC becomes its primary target, and raw threat percentage simplifies this comparison. However, most NPCs are designed to maintain some degree of target focus -- so that they don't rapidly switch targets if, for example, a unit other than the primary target suddenly reaches 101% raw threat. The amount by which a unit must surpass the primary target's threat to become the new primary target varies by distance from the NPC.  Thus, a scaled percentage value is given to provide clarity. The rawPercent value returned from this function can be greater than 100 (indicating that unit has greater threat against mobUnit than mobUnit's primary target, and is thus in danger of becoming the primary target), but the scaledPercent value will always be 100 or lower. Threat information for a pair of units is only returned if the player has threat against the NPC unit in question. (For example, no threat data is provided if the player's pet is attacking an NPC but the player himself has taken no action, even though the pet has threat against the NPC.) +function UnitDetailedThreatSituation(unit, name, mobUnit) end \ No newline at end of file diff --git a/api/UnitDistanceSquared.lua b/api/UnitDistanceSquared.lua new file mode 100644 index 0000000..c18dee0 --- /dev/null +++ b/api/UnitDistanceSquared.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return number distanceSquared +---@return boolean checkedDistance +---Returns the squared distance to a unit in the player's group. The distance returned appears to work from anywhere (even across continents and instance boundaries, although the answer is of dubious value). +function UnitDistanceSquared(unit) end \ No newline at end of file diff --git a/api/UnitExists.lua b/api/UnitExists.lua new file mode 100644 index 0000000..7a8ee7d --- /dev/null +++ b/api/UnitExists.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return 1nil exists +---Returns whether a unit exists. A unit "exists" if it can be referenced by the player; e.g. party1 exists if the player is in a party with at least one other member (regardless of whether that member is nearby), target exists if the player has a target, npc exists if the player is currently interacting with an NPC, etc. +function UnitExists(unit, name) end \ No newline at end of file diff --git a/api/UnitFactionGroup.lua b/api/UnitFactionGroup.lua new file mode 100644 index 0000000..a37c111 --- /dev/null +++ b/api/UnitFactionGroup.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return string factionGroup +---@return string factionName +---Returns a unit's primary faction allegiance +function UnitFactionGroup(unit, name) end \ No newline at end of file diff --git a/api/UnitFullName.lua b/api/UnitFullName.lua new file mode 100644 index 0000000..d5a2f03 --- /dev/null +++ b/api/UnitFullName.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Will return a units name appended with the realm name without spaces. . UnitFullName(unit) will return a players name appended with the "shortened" realmname; this would be the realm name without spaces. +function UnitFullName() end \ No newline at end of file diff --git a/api/UnitGUID.lua b/api/UnitGUID.lua new file mode 100644 index 0000000..4cb3914 --- /dev/null +++ b/api/UnitGUID.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return string guid +---Returns a unit's globally unique identifier +function UnitGUID(unit) end \ No newline at end of file diff --git a/api/UnitGetAvailableRoles.lua b/api/UnitGetAvailableRoles.lua new file mode 100644 index 0000000..e5dcdd6 --- /dev/null +++ b/api/UnitGetAvailableRoles.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return boolean canBeTank +---@return boolean canBeHealer +---@return boolean canBeDPS +---Get what roles a unit can play in the group or raid. See UnitSetRole("unit", "role") +function UnitGetAvailableRoles(unit) end \ No newline at end of file diff --git a/api/UnitGetIncomingHeals.lua b/api/UnitGetIncomingHeals.lua new file mode 100644 index 0000000..797dd99 --- /dev/null +++ b/api/UnitGetIncomingHeals.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitGetIncomingHeals() end \ No newline at end of file diff --git a/api/UnitGetTotalAbsorbs.lua b/api/UnitGetTotalAbsorbs.lua new file mode 100644 index 0000000..dd33343 --- /dev/null +++ b/api/UnitGetTotalAbsorbs.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitGetTotalAbsorbs() end \ No newline at end of file diff --git a/api/UnitGetTotalHealAbsorbs.lua b/api/UnitGetTotalHealAbsorbs.lua new file mode 100644 index 0000000..a38d41a --- /dev/null +++ b/api/UnitGetTotalHealAbsorbs.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitGetTotalHealAbsorbs() end \ No newline at end of file diff --git a/api/UnitGroupRolesAssigned.lua b/api/UnitGroupRolesAssigned.lua new file mode 100644 index 0000000..5e452c7 --- /dev/null +++ b/api/UnitGroupRolesAssigned.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return TANK role +---@return DAMAGER +---@return HEALER +---@return NONE +---@return TANK +---Returns information about a unit's role in a group +function UnitGroupRolesAssigned(unit) end \ No newline at end of file diff --git a/api/UnitHPPerStamina.lua b/api/UnitHPPerStamina.lua new file mode 100644 index 0000000..0d6a57e --- /dev/null +++ b/api/UnitHPPerStamina.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitHPPerStamina() end \ No newline at end of file diff --git a/api/UnitHasIncomingResurrection.lua b/api/UnitHasIncomingResurrection.lua new file mode 100644 index 0000000..de8f48a --- /dev/null +++ b/api/UnitHasIncomingResurrection.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return boolean isBeingRessed +---Check if a unit is being resurrected. You can pass either a unitID ("player", "party1", "target") or a unit name ("Cladhaire", "Vanhoeffen"). +function UnitHasIncomingResurrection(unit) end \ No newline at end of file diff --git a/api/UnitHasLFGDeserter.lua b/api/UnitHasLFGDeserter.lua new file mode 100644 index 0000000..ad61e0c --- /dev/null +++ b/api/UnitHasLFGDeserter.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitHasLFGDeserter() end \ No newline at end of file diff --git a/api/UnitHasLFGRandomCooldown.lua b/api/UnitHasLFGRandomCooldown.lua new file mode 100644 index 0000000..e2a0432 --- /dev/null +++ b/api/UnitHasLFGRandomCooldown.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitHasLFGRandomCooldown() end \ No newline at end of file diff --git a/api/UnitHasRelicSlot.lua b/api/UnitHasRelicSlot.lua new file mode 100644 index 0000000..436d172 --- /dev/null +++ b/api/UnitHasRelicSlot.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return 1nil hasRelic +---Returns whether a unit has a relic slot instead of a ranged weapon slot +function UnitHasRelicSlot(unit) end \ No newline at end of file diff --git a/api/UnitHasVehiclePlayerFrameUI.lua b/api/UnitHasVehiclePlayerFrameUI.lua new file mode 100644 index 0000000..e9a2a3b --- /dev/null +++ b/api/UnitHasVehiclePlayerFrameUI.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitHasVehiclePlayerFrameUI() end \ No newline at end of file diff --git a/api/UnitHasVehicleUI.lua b/api/UnitHasVehicleUI.lua new file mode 100644 index 0000000..16897f1 --- /dev/null +++ b/api/UnitHasVehicleUI.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return boolean hasVehicle +---Returns whether a unit is controlling a vehicle or vehicle weapon. Used in the default UI to show the vehicle's health and power status bars in place of the controlling unit's. Returns false for passengers riding in but not controlling part of a vehicle; to find out whether a unit is riding in a vehicle, use UnitInVehicle. Also note that in some vehicles the player can command a vehicle weapon (e.g. gun turret) without controlling the vehicle itself; to find out whether a unit is controlling a vehicle, use UnitControllingVehicle. +function UnitHasVehicleUI(unit, name) end \ No newline at end of file diff --git a/api/UnitHealth.lua b/api/UnitHealth.lua new file mode 100644 index 0000000..adccd7e --- /dev/null +++ b/api/UnitHealth.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return number health +---Returns a unit's current amount of health +function UnitHealth(unit, name) end \ No newline at end of file diff --git a/api/UnitHealthMax.lua b/api/UnitHealthMax.lua new file mode 100644 index 0000000..68cb19e --- /dev/null +++ b/api/UnitHealthMax.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return number maxValue +---Returns a unit's maximum health value +function UnitHealthMax(unit, name) end \ No newline at end of file diff --git a/api/UnitInBattleground.lua b/api/UnitInBattleground.lua new file mode 100644 index 0000000..2d12b9f --- /dev/null +++ b/api/UnitInBattleground.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return number raidNum +---Returns whether a unit is in same battleground instance as the player +function UnitInBattleground(unit) end \ No newline at end of file diff --git a/api/UnitInOtherParty.lua b/api/UnitInOtherParty.lua new file mode 100644 index 0000000..5a21a04 --- /dev/null +++ b/api/UnitInOtherParty.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitInOtherParty() end \ No newline at end of file diff --git a/api/UnitInParty.lua b/api/UnitInParty.lua new file mode 100644 index 0000000..ef33427 --- /dev/null +++ b/api/UnitInParty.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return 1nil inParty +---Returns whether a unit is a player unit in the player's party. Always returns 1 for the player unit. Returns nil for the player's or party members' pets. +function UnitInParty(unit, name) end \ No newline at end of file diff --git a/api/UnitInPhase.lua b/api/UnitInPhase.lua new file mode 100644 index 0000000..aa66405 --- /dev/null +++ b/api/UnitInPhase.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unitID unitID +---@return 1nil inPhase +---Return information if unit is in this same phase. +function UnitInPhase(unitID) end \ No newline at end of file diff --git a/api/UnitInRaid.lua b/api/UnitInRaid.lua new file mode 100644 index 0000000..f0cfe93 --- /dev/null +++ b/api/UnitInRaid.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return number inRaid +---Returns whether a unit is in the player's raid +function UnitInRaid(unit) end \ No newline at end of file diff --git a/api/UnitInRange.lua b/api/UnitInRange.lua new file mode 100644 index 0000000..7bcc693 --- /dev/null +++ b/api/UnitInRange.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return 1nil inRange +---Returns whether a party/raid member is nearby. The range check used by this function isn't directly based on the player's abilities (which may have varying ranges); it's fixed by Blizzard at a distance of around 40 yards (which encompasses many common healing spells and other abilities often used on raid members). Also returns nil for units outside the player's area of view. +function UnitInRange(unit, name) end \ No newline at end of file diff --git a/api/UnitInVehicle.lua b/api/UnitInVehicle.lua new file mode 100644 index 0000000..142b414 --- /dev/null +++ b/api/UnitInVehicle.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return 1nil inVehicle +---Returns whether a unit is in a vehicle. A unit can be riding in a vehicle without controlling it: to test whether a unit is controlling a vehicle, use UnitControllingVehicle or UnitHasVehicleUI. Note: multi-passenger mounts appear as vehicles for passengers but not for the owner. +function UnitInVehicle(unit, name) end \ No newline at end of file diff --git a/api/UnitInVehicleControlSeat.lua b/api/UnitInVehicleControlSeat.lua new file mode 100644 index 0000000..2079386 --- /dev/null +++ b/api/UnitInVehicleControlSeat.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean isInControl +---Returns whether a unit controls a vehicle +function UnitInVehicleControlSeat() end \ No newline at end of file diff --git a/api/UnitInVehicleHidesPetFrame.lua b/api/UnitInVehicleHidesPetFrame.lua new file mode 100644 index 0000000..a05e037 --- /dev/null +++ b/api/UnitInVehicleHidesPetFrame.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitInVehicleHidesPetFrame() end \ No newline at end of file diff --git a/api/UnitIsAFK.lua b/api/UnitIsAFK.lua new file mode 100644 index 0000000..8aaa4a9 --- /dev/null +++ b/api/UnitIsAFK.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return 1nil isAFK +---Returns whether a unit is marked AFK (Away From Keyboard) +function UnitIsAFK(unit, name) end \ No newline at end of file diff --git a/api/UnitIsBattlePet.lua b/api/UnitIsBattlePet.lua new file mode 100644 index 0000000..1a877a4 --- /dev/null +++ b/api/UnitIsBattlePet.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitIsBattlePet() end \ No newline at end of file diff --git a/api/UnitIsBattlePetCompanion.lua b/api/UnitIsBattlePetCompanion.lua new file mode 100644 index 0000000..8f05625 --- /dev/null +++ b/api/UnitIsBattlePetCompanion.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitIsBattlePetCompanion() end \ No newline at end of file diff --git a/api/UnitIsCharmed.lua b/api/UnitIsCharmed.lua new file mode 100644 index 0000000..ff7d77a --- /dev/null +++ b/api/UnitIsCharmed.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return 1nil isCharmed +---Returns whether a unit is currently charmed. A charmed unit is affected by Mind Control (or a similar effect) and thus hostile to units which are normally his or her allies. +function UnitIsCharmed(unit) end \ No newline at end of file diff --git a/api/UnitIsConnected.lua b/api/UnitIsConnected.lua new file mode 100644 index 0000000..fdded92 --- /dev/null +++ b/api/UnitIsConnected.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return 1nil isConnected +---Returns whether a unit is connected (i.e. not Offline) +function UnitIsConnected(unit) end \ No newline at end of file diff --git a/api/UnitIsControlling.lua b/api/UnitIsControlling.lua new file mode 100644 index 0000000..b332cf1 --- /dev/null +++ b/api/UnitIsControlling.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return 1nil isControlling +---Returns whether a unit is controlling another unit. Applies to Mind Control and similar cases as well as to players piloting vehicles. +function UnitIsControlling(unit) end \ No newline at end of file diff --git a/api/UnitIsCorpse.lua b/api/UnitIsCorpse.lua new file mode 100644 index 0000000..de21118 --- /dev/null +++ b/api/UnitIsCorpse.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return 1nil isCorpse +---Returns whether a unit is a corpse +function UnitIsCorpse(unit) end \ No newline at end of file diff --git a/api/UnitIsDND.lua b/api/UnitIsDND.lua new file mode 100644 index 0000000..387328d --- /dev/null +++ b/api/UnitIsDND.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return 1nil isDND +---Returns whether a unit is marked DND (Do Not Disturb) +function UnitIsDND(unit, name) end \ No newline at end of file diff --git a/api/UnitIsDead.lua b/api/UnitIsDead.lua new file mode 100644 index 0000000..23513da --- /dev/null +++ b/api/UnitIsDead.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return 1nil isDead +---Returns whether a unit is dead. Only returns 1 while the unit is dead and has not yet released his or her spirit. See UnitIsGhost() for after the unit has released. +function UnitIsDead(unit) end \ No newline at end of file diff --git a/api/UnitIsDeadOrGhost.lua b/api/UnitIsDeadOrGhost.lua new file mode 100644 index 0000000..dc40701 --- /dev/null +++ b/api/UnitIsDeadOrGhost.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return 1nil isDeadOrGhost +---Returns whether a unit is either dead or a ghost +function UnitIsDeadOrGhost(unit) end \ No newline at end of file diff --git a/api/UnitIsEnemy.lua b/api/UnitIsEnemy.lua new file mode 100644 index 0000000..bb18a84 --- /dev/null +++ b/api/UnitIsEnemy.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param unit string +---@return 1nil isEnemy +---Returns whether two units are enemies +function UnitIsEnemy(unit, unit) end \ No newline at end of file diff --git a/api/UnitIsFeignDeath.lua b/api/UnitIsFeignDeath.lua new file mode 100644 index 0000000..977303b --- /dev/null +++ b/api/UnitIsFeignDeath.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return 1nil isFeign +---Returns whether a unit is feigning death. Only provides valid data for friendly units. +function UnitIsFeignDeath(unit) end \ No newline at end of file diff --git a/api/UnitIsFriend.lua b/api/UnitIsFriend.lua new file mode 100644 index 0000000..5b25c96 --- /dev/null +++ b/api/UnitIsFriend.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param unit string +---@return 1nil isFriends +---Returns whether two units are friendly +function UnitIsFriend(unit, unit) end \ No newline at end of file diff --git a/api/UnitIsGhost.lua b/api/UnitIsGhost.lua new file mode 100644 index 0000000..4b1dc3c --- /dev/null +++ b/api/UnitIsGhost.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return 1nil isGhost +---Returns whether a unit is currently a ghost +function UnitIsGhost(unit) end \ No newline at end of file diff --git a/api/UnitIsGroupAssistant.lua b/api/UnitIsGroupAssistant.lua new file mode 100644 index 0000000..55a12c7 --- /dev/null +++ b/api/UnitIsGroupAssistant.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitIsGroupAssistant() end \ No newline at end of file diff --git a/api/UnitIsGroupLeader.lua b/api/UnitIsGroupLeader.lua new file mode 100644 index 0000000..ff9f852 --- /dev/null +++ b/api/UnitIsGroupLeader.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return bool leader +---Returns whether a unit is the raid leader. +function UnitIsGroupLeader(unit, name) end \ No newline at end of file diff --git a/api/UnitIsInMyGuild.lua b/api/UnitIsInMyGuild.lua new file mode 100644 index 0000000..c77e3f3 --- /dev/null +++ b/api/UnitIsInMyGuild.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return 1nil inGuild +---Returns whether a unit is in the player's guild +function UnitIsInMyGuild(unit) end \ No newline at end of file diff --git a/api/UnitIsOtherPlayersBattlePet.lua b/api/UnitIsOtherPlayersBattlePet.lua new file mode 100644 index 0000000..33720c1 --- /dev/null +++ b/api/UnitIsOtherPlayersBattlePet.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitIsOtherPlayersBattlePet() end \ No newline at end of file diff --git a/api/UnitIsOtherPlayersPet.lua b/api/UnitIsOtherPlayersPet.lua new file mode 100644 index 0000000..a8f79cb --- /dev/null +++ b/api/UnitIsOtherPlayersPet.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return boolean isPet +---Returns whether or not the unit is another player's permanent pet +function UnitIsOtherPlayersPet(unit) end \ No newline at end of file diff --git a/api/UnitIsPVP.lua b/api/UnitIsPVP.lua new file mode 100644 index 0000000..8d40f96 --- /dev/null +++ b/api/UnitIsPVP.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return 1nil isPVP +---Returns whether a unit is flagged for PvP activity +function UnitIsPVP(unit) end \ No newline at end of file diff --git a/api/UnitIsPVPFreeForAll.lua b/api/UnitIsPVPFreeForAll.lua new file mode 100644 index 0000000..da03fbd --- /dev/null +++ b/api/UnitIsPVPFreeForAll.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return 1nil isFreeForAll +---Returns whether a unit is flagged for free-for-all PvP. Free-for-all PvP allows all players to attack each other regardless of faction; used in certain outdoor areas (such as Gurubashi Arena and "The Maul" outside Dire Maul). +function UnitIsPVPFreeForAll(unit) end \ No newline at end of file diff --git a/api/UnitIsPVPSanctuary.lua b/api/UnitIsPVPSanctuary.lua new file mode 100644 index 0000000..97f2136 --- /dev/null +++ b/api/UnitIsPVPSanctuary.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return 1nil state +---Returns whether a unit is in a Sanctuary area preventing PvP activity +function UnitIsPVPSanctuary(unit) end \ No newline at end of file diff --git a/api/UnitIsPlayer.lua b/api/UnitIsPlayer.lua new file mode 100644 index 0000000..c998316 --- /dev/null +++ b/api/UnitIsPlayer.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return boolean isPlayer +---Returns whether a unit is a player unit (not an NPC) +function UnitIsPlayer(unit) end \ No newline at end of file diff --git a/api/UnitIsPossessed.lua b/api/UnitIsPossessed.lua new file mode 100644 index 0000000..2e2628a --- /dev/null +++ b/api/UnitIsPossessed.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return 1nil isPossessed +---Returns whether a unit is possessed by another +function UnitIsPossessed(unit) end \ No newline at end of file diff --git a/api/UnitIsQuestBoss.lua b/api/UnitIsQuestBoss.lua new file mode 100644 index 0000000..98f3dfa --- /dev/null +++ b/api/UnitIsQuestBoss.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitIsQuestBoss() end \ No newline at end of file diff --git a/api/UnitIsRaidOfficer.lua b/api/UnitIsRaidOfficer.lua new file mode 100644 index 0000000..4b0c08c --- /dev/null +++ b/api/UnitIsRaidOfficer.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return 1nil leader +---Returns whether a unit is a raid assistant in the player's raid +function UnitIsRaidOfficer(unit, name) end \ No newline at end of file diff --git a/api/UnitIsSameServer.lua b/api/UnitIsSameServer.lua new file mode 100644 index 0000000..fddd257 --- /dev/null +++ b/api/UnitIsSameServer.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param unit string +---@return 1nil isSame +---Returns whether two units are from the same server +function UnitIsSameServer(unit, unit) end \ No newline at end of file diff --git a/api/UnitIsSilenced.lua b/api/UnitIsSilenced.lua new file mode 100644 index 0000000..131a4b3 --- /dev/null +++ b/api/UnitIsSilenced.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param channel string +---@return 1nil silenced +---Returns whether a character is silenced on a voice channel +function UnitIsSilenced(name, channel) end \ No newline at end of file diff --git a/api/UnitIsTalking.lua b/api/UnitIsTalking.lua new file mode 100644 index 0000000..8cbe400 --- /dev/null +++ b/api/UnitIsTalking.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return 1nil state +---Returns whether a unit is currently speaking in voice chat. Despite the "unit" name, this function only accepts player names, not unitIDs. +function UnitIsTalking(unit) end \ No newline at end of file diff --git a/api/UnitIsTapped.lua b/api/UnitIsTapped.lua new file mode 100644 index 0000000..a62a7f4 --- /dev/null +++ b/api/UnitIsTapped.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit unitId +---Returns whether a unit is tapped. Normally, rewards for killing a unit are available only to the character or group who first damaged the unit; once a character has thus established his claim on the unit, it is considered "tapped". +function UnitIsTapped(unit) end \ No newline at end of file diff --git a/api/UnitIsTappedByAllThreatList.lua b/api/UnitIsTappedByAllThreatList.lua new file mode 100644 index 0000000..0b629d7 --- /dev/null +++ b/api/UnitIsTappedByAllThreatList.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return 1nil allTapped +---Returns whether a unit allows all players on its threat list to receive kill credit. Used to override the normal "tapping" behavior for certain mobs -- if this function returns 1, the player does not have to be the first to attack the mob (or in the same party/raid as the first player to attack) in order to receive quest or achievement credit for killing it. In the default UI, this function can prevent the graying of a unit's name background in the TargetFrame and FocusFrame even if the unit is otherwise tapped, indicating that kill credit is still available if the player attacks. +function UnitIsTappedByAllThreatList(unit) end \ No newline at end of file diff --git a/api/UnitIsTappedByPlayer.lua b/api/UnitIsTappedByPlayer.lua new file mode 100644 index 0000000..f777733 --- /dev/null +++ b/api/UnitIsTappedByPlayer.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return 1nil isTapped +---Returns whether a unit is tapped by the player or the player's group. Normally, rewards for killing a unit are available only to the character or group who first damaged the unit; once a character has thus established his claim on the unit, it is considered "tapped". +function UnitIsTappedByPlayer(unit) end \ No newline at end of file diff --git a/api/UnitIsTrivial.lua b/api/UnitIsTrivial.lua new file mode 100644 index 0000000..44c604f --- /dev/null +++ b/api/UnitIsTrivial.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return 1nil isTrivial +---Returns whether a unit is trivial at the player's level. Killing trivial units (whose level is colored gray in the default UI) does not reward honor or experience. +function UnitIsTrivial(unit) end \ No newline at end of file diff --git a/api/UnitIsUnconscious.lua b/api/UnitIsUnconscious.lua new file mode 100644 index 0000000..bb2d125 --- /dev/null +++ b/api/UnitIsUnconscious.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitIsUnconscious() end \ No newline at end of file diff --git a/api/UnitIsUnit.lua b/api/UnitIsUnit.lua new file mode 100644 index 0000000..fb15081 --- /dev/null +++ b/api/UnitIsUnit.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param unit string +---@return 1nil isSame +---Returns whether two unit references are to the same unit. Useful for determining whether a composite unitID (such as raid19target) also refers to a basic unitID; see example. +function UnitIsUnit(unit, unit) end \ No newline at end of file diff --git a/api/UnitIsVisible.lua b/api/UnitIsVisible.lua new file mode 100644 index 0000000..ba7272a --- /dev/null +++ b/api/UnitIsVisible.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return 1nil isVisible +---Returns whether a unit is in the player's area of interest +function UnitIsVisible(unit) end \ No newline at end of file diff --git a/api/UnitIsWildBattlePet.lua b/api/UnitIsWildBattlePet.lua new file mode 100644 index 0000000..10f3235 --- /dev/null +++ b/api/UnitIsWildBattlePet.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitIsWildBattlePet() end \ No newline at end of file diff --git a/api/UnitLeadsAnyGroup.lua b/api/UnitLeadsAnyGroup.lua new file mode 100644 index 0000000..caf8ba5 --- /dev/null +++ b/api/UnitLeadsAnyGroup.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return boolean uLead +---Returns whether a unit is the leader of any group +function UnitLeadsAnyGroup(unit) end \ No newline at end of file diff --git a/api/UnitLevel.lua b/api/UnitLevel.lua new file mode 100644 index 0000000..d795936 --- /dev/null +++ b/api/UnitLevel.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return number level +---Returns a unit's level. Returns -1 for boss units and hostile units whose level is ten levels or more above the player's. +function UnitLevel(unit) end \ No newline at end of file diff --git a/api/UnitMana.lua b/api/UnitMana.lua new file mode 100644 index 0000000..d74a236 --- /dev/null +++ b/api/UnitMana.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitMana() end \ No newline at end of file diff --git a/api/UnitManaMax.lua b/api/UnitManaMax.lua new file mode 100644 index 0000000..cba4514 --- /dev/null +++ b/api/UnitManaMax.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitManaMax() end \ No newline at end of file diff --git a/api/UnitName.lua b/api/UnitName.lua new file mode 100644 index 0000000..69a8da4 --- /dev/null +++ b/api/UnitName.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return string name +---@return string realm +---Returns the name of a unit +function UnitName(unit) end \ No newline at end of file diff --git a/api/UnitNumPowerBarTimers.lua b/api/UnitNumPowerBarTimers.lua new file mode 100644 index 0000000..f2400af --- /dev/null +++ b/api/UnitNumPowerBarTimers.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitNumPowerBarTimers() end \ No newline at end of file diff --git a/api/UnitOnTaxi.lua b/api/UnitOnTaxi.lua new file mode 100644 index 0000000..4266bf4 --- /dev/null +++ b/api/UnitOnTaxi.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return 1nil onTaxi +---Returns whether a unit is currently riding a flight path (taxi). Valid for any unit in the player's area of interest, but generally useful only for player -- taxi flights move quickly, so a taxi-riding unit visible to the player will not remain visible for very long. +function UnitOnTaxi(unit) end \ No newline at end of file diff --git a/api/UnitPVPName.lua b/api/UnitPVPName.lua new file mode 100644 index 0000000..839ea58 --- /dev/null +++ b/api/UnitPVPName.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return string name +---Returns the name of a unit including the unit's current title. Titles are no longer specific to PvP; this function returns a unit's name with whichever title he or she is currently displaying (e.g. "Gladiator Spin", "Keydar Jenkins", "Ownsusohard, Champion of the Frozen Wastes", etc). +function UnitPVPName(unit) end \ No newline at end of file diff --git a/api/UnitPlayerControlled.lua b/api/UnitPlayerControlled.lua new file mode 100644 index 0000000..8a9551b --- /dev/null +++ b/api/UnitPlayerControlled.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return 1nil isPlayer +---Returns whether a unit is controlled by a player +function UnitPlayerControlled(unit) end \ No newline at end of file diff --git a/api/UnitPlayerOrPetInParty.lua b/api/UnitPlayerOrPetInParty.lua new file mode 100644 index 0000000..596ff82 --- /dev/null +++ b/api/UnitPlayerOrPetInParty.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return 1nil inParty +---Returns whether a unit is in the player's party or belongs to a party member. Returns nil for the player and the player's pet. +function UnitPlayerOrPetInParty(unit, name) end \ No newline at end of file diff --git a/api/UnitPlayerOrPetInRaid.lua b/api/UnitPlayerOrPetInRaid.lua new file mode 100644 index 0000000..00ea501 --- /dev/null +++ b/api/UnitPlayerOrPetInRaid.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return 1nil inParty +---Returns whether a unit is in the player's raid or belongs to a raid member +function UnitPlayerOrPetInRaid(unit, name) end \ No newline at end of file diff --git a/api/UnitPosition.lua b/api/UnitPosition.lua new file mode 100644 index 0000000..ee149e7 --- /dev/null +++ b/api/UnitPosition.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitPosition() end \ No newline at end of file diff --git a/api/UnitPower.lua b/api/UnitPower.lua new file mode 100644 index 0000000..b78aff1 --- /dev/null +++ b/api/UnitPower.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unitID string +---@param powerType number +---@return number power +---Returns a unit's current level of mana, rage, energy or other power type. Returns zero for non-existent units. +function UnitPower(unitID, powerType) end \ No newline at end of file diff --git a/api/UnitPowerBarTimerInfo.lua b/api/UnitPowerBarTimerInfo.lua new file mode 100644 index 0000000..ba8d72a --- /dev/null +++ b/api/UnitPowerBarTimerInfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitPowerBarTimerInfo() end \ No newline at end of file diff --git a/api/UnitPowerMax.lua b/api/UnitPowerMax.lua new file mode 100644 index 0000000..f228255 --- /dev/null +++ b/api/UnitPowerMax.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unitID string +---@param powerType number +---@return number maxValue +---Returns a unit's maximum mana, rage, energy or other power type. Returns the units current maximum power, if the unit does not exist then zero is returned. When querying with a powerType, as long as the unit exists you will get the maximum untalented power even if the class does not use the power type. +function UnitPowerMax(unitID, powerType) end \ No newline at end of file diff --git a/api/UnitPowerType.lua b/api/UnitPowerType.lua new file mode 100644 index 0000000..6375974 --- /dev/null +++ b/api/UnitPowerType.lua @@ -0,0 +1,16 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return 6 powerType +---@return 0 +---@return 1 +---@return 2 +---@return 3 +---@return 6 +---@return string powerToken +---@return number altR +---@return number altG +---@return number altB +---Returns the power type (energy, mana, rage) of the given unit. Does not return color values for common power types (mana, rage, energy, focus, and runic power); the canonical colors for these can be found in the PowerBarColor table. Color values may be included for special power types such as those used by vehicles. +function UnitPowerType(unit, name) end \ No newline at end of file diff --git a/api/UnitRace.lua b/api/UnitRace.lua new file mode 100644 index 0000000..7a7016f --- /dev/null +++ b/api/UnitRace.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return string race +---@return string fileName +---Returns the name of a unit's race +function UnitRace(unit) end \ No newline at end of file diff --git a/api/UnitRangedAttack.lua b/api/UnitRangedAttack.lua new file mode 100644 index 0000000..0064f14 --- /dev/null +++ b/api/UnitRangedAttack.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return number rangedAttackBase +---@return number rangedAttackMod +---Returns information about the player's or pet's ranged weapon skill +function UnitRangedAttack(unit) end \ No newline at end of file diff --git a/api/UnitRangedAttackPower.lua b/api/UnitRangedAttackPower.lua new file mode 100644 index 0000000..e58f318 --- /dev/null +++ b/api/UnitRangedAttackPower.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return number base +---@return number posBuff +---@return number negBuff +---Returns the player's or pet's ranged attack power +function UnitRangedAttackPower(unit) end \ No newline at end of file diff --git a/api/UnitRangedDamage.lua b/api/UnitRangedDamage.lua new file mode 100644 index 0000000..e12c0a7 --- /dev/null +++ b/api/UnitRangedDamage.lua @@ -0,0 +1,11 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return number rangedAttackSpeed +---@return number minDamage +---@return number maxDamage +---@return number physicalBonusPos +---@return number physicalBonusNeg +---@return number percent +---Returns information about the player's or pet's ranged attack damage and speed +function UnitRangedDamage(unit) end \ No newline at end of file diff --git a/api/UnitReaction.lua b/api/UnitReaction.lua new file mode 100644 index 0000000..eac9d78 --- /dev/null +++ b/api/UnitReaction.lua @@ -0,0 +1,15 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param unit string +---@return 8 reaction +---@return 1 +---@return 2 +---@return 3 +---@return 4 +---@return 5 +---@return 6 +---@return 7 +---@return 8 +---Returns the reaction of one unit with regards to another as a number. The returned value often (but not always) matches the unit's level of reputation with the second unit's faction, and can be used with the UnitReactionColor global table to return the color used to display a unit's reaction in the default UI. +function UnitReaction(unit, unit) end \ No newline at end of file diff --git a/api/UnitRealmRelationship.lua b/api/UnitRealmRelationship.lua new file mode 100644 index 0000000..8a83019 --- /dev/null +++ b/api/UnitRealmRelationship.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitRealmRelationship() end \ No newline at end of file diff --git a/api/UnitResistance.lua b/api/UnitResistance.lua new file mode 100644 index 0000000..d104e69 --- /dev/null +++ b/api/UnitResistance.lua @@ -0,0 +1,15 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param resistanceIndex 5 +---@param 1 +---@param 2 +---@param 3 +---@param 4 +---@param 5 +---@return number base +---@return number resistance +---@return number positive +---@return number negative +---Returns information about the player's or pet's magic resistance +function UnitResistance(unit, resistanceIndex, 1, 2, 3, 4, 5) end \ No newline at end of file diff --git a/api/UnitSelectionColor.lua b/api/UnitSelectionColor.lua new file mode 100644 index 0000000..81e06d3 --- /dev/null +++ b/api/UnitSelectionColor.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return number red +---@return number green +---@return number blue +---@return number alpha +---Returns a color indicating hostility and related status of a unit. This color is used in various places in the default UI, such as the background behind a unit's name in the target and focus frames. For NPCs, the color reflects hostility and reputation, ranging from red (hostile) to orange or yellow (unfriendly or neutral) to green (friendly). When the unit is a player, a blue color is used unless the player is active for PvP, in which case the color may be red (he can attack you and you can attack him), yellow (you can attack him but he can't attack you) or green (ally). Color component values are floating point numbers between 0 and 1. +function UnitSelectionColor(unit, name) end \ No newline at end of file diff --git a/api/UnitSetRole.lua b/api/UnitSetRole.lua new file mode 100644 index 0000000..6f1835e --- /dev/null +++ b/api/UnitSetRole.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param role TANK +---@param DAMAGER +---@param HEALER +---@param NONE +---@param TANK +---Sets a unit's role in the group or raid +function UnitSetRole(unit, role, DAMAGER, HEALER, NONE, TANK) end \ No newline at end of file diff --git a/api/UnitSex.lua b/api/UnitSex.lua new file mode 100644 index 0000000..53048f0 --- /dev/null +++ b/api/UnitSex.lua @@ -0,0 +1,10 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return 3 gender +---@return 1 +---@return 2 +---@return 3 +---Returns the gender of the given unit or player +function UnitSex(unit, name) end \ No newline at end of file diff --git a/api/UnitSpellHaste.lua b/api/UnitSpellHaste.lua new file mode 100644 index 0000000..6ada040 --- /dev/null +++ b/api/UnitSpellHaste.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return number haste +---Returns the unit's spell haste as a percentage +function UnitSpellHaste(unit, name) end \ No newline at end of file diff --git a/api/UnitStagger.lua b/api/UnitStagger.lua new file mode 100644 index 0000000..4668f73 --- /dev/null +++ b/api/UnitStagger.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitStagger() end \ No newline at end of file diff --git a/api/UnitStat.lua b/api/UnitStat.lua new file mode 100644 index 0000000..4355f85 --- /dev/null +++ b/api/UnitStat.lua @@ -0,0 +1,15 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param statIndex 5 +---@param 1 +---@param 2 +---@param 3 +---@param 4 +---@param 5 +---@return number stat +---@return number effectiveStat +---@return number posBuff +---@return number negBuff +---Returns information about a basic character statistic for the player or pet +function UnitStat(unit, statIndex, 1, 2, 3, 4, 5) end \ No newline at end of file diff --git a/api/UnitSwitchToVehicleSeat.lua b/api/UnitSwitchToVehicleSeat.lua new file mode 100644 index 0000000..8e9bdd9 --- /dev/null +++ b/api/UnitSwitchToVehicleSeat.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param seat number +---Moves the player to another seat within his current vehicle +function UnitSwitchToVehicleSeat(unit, seat) end \ No newline at end of file diff --git a/api/UnitTargetsVehicleInRaidUI.lua b/api/UnitTargetsVehicleInRaidUI.lua new file mode 100644 index 0000000..7a238c2 --- /dev/null +++ b/api/UnitTargetsVehicleInRaidUI.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return boolean targetVehicle +---Returns whether attempts to target a unit should target its vehicle. The unit can still be targeted: this flag is used to provide a convenience in the default UI for certain cases (such as the Malygos encounter) such that clicking a unit in the raid UI targets its vehicle (e.g. so players can use their drakes to heal other players' drakes). +function UnitTargetsVehicleInRaidUI(unit) end \ No newline at end of file diff --git a/api/UnitThreatPercentageOfLead.lua b/api/UnitThreatPercentageOfLead.lua new file mode 100644 index 0000000..42bfcba --- /dev/null +++ b/api/UnitThreatPercentageOfLead.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnitThreatPercentageOfLead() end \ No newline at end of file diff --git a/api/UnitThreatSituation.lua b/api/UnitThreatSituation.lua new file mode 100644 index 0000000..6766594 --- /dev/null +++ b/api/UnitThreatSituation.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit unitid +---@param name string +---@param mobUnit unitid +---@return mobUnit status +---@return 0 +---@return mobUnit 1 +---@return mobUnit 2 +---@return mobUnit 3 +---Returns the general threat status of a unit. See UnitDetailedThreatSituation for details about threat values. Threat information for a pair of units is only returned if the player has threat against the NPC unit in question. (For example, no threat data is provided if the player's pet is attacking an NPC but the player himself has taken no action, even though the pet has threat against the NPC.) +function UnitThreatSituation(unit, name, mobUnit) end \ No newline at end of file diff --git a/api/UnitUsingVehicle.lua b/api/UnitUsingVehicle.lua new file mode 100644 index 0000000..a991394 --- /dev/null +++ b/api/UnitUsingVehicle.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return 1nil usingVehicle +---Returns whether a unit is using a vehicle. Unlike similar functions, UnitUsingVehicle() also returns true while the unit is transitioning between seats in a vehicle. +function UnitUsingVehicle(unit) end \ No newline at end of file diff --git a/api/UnitVehicleSeatCount.lua b/api/UnitVehicleSeatCount.lua new file mode 100644 index 0000000..d69cfea --- /dev/null +++ b/api/UnitVehicleSeatCount.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return number numSeats +---Returns the number of seats in a unit's vehicle. Note: returns 0 for multi-passenger mounts even thought multiple seats are available. +function UnitVehicleSeatCount(unit) end \ No newline at end of file diff --git a/api/UnitVehicleSeatInfo.lua b/api/UnitVehicleSeatInfo.lua new file mode 100644 index 0000000..108a0a9 --- /dev/null +++ b/api/UnitVehicleSeatInfo.lua @@ -0,0 +1,14 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param seat number +---@return Root controlType +---@return Child +---@return None +---@return Root +---@return string occupantName +---@return string occupantRealm +---@return boolean canEject +---@return boolean canSwitchSeats +---Returns information about seats in a vehicle. Note: multi-passenger mounts appear as vehicles for passengers but not for the owner; seat information applies only to the passenger seats. +function UnitVehicleSeatInfo(unit, seat) end \ No newline at end of file diff --git a/api/UnitVehicleSkin.lua b/api/UnitVehicleSkin.lua new file mode 100644 index 0000000..7194812 --- /dev/null +++ b/api/UnitVehicleSkin.lua @@ -0,0 +1,9 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@param name string +---@return Natural skin +---@return Mechanical +---@return Natural +---Returns the style of vehicle UI to display for a unit +function UnitVehicleSkin(unit, name) end \ No newline at end of file diff --git a/api/UnitXP.lua b/api/UnitXP.lua new file mode 100644 index 0000000..2cf9954 --- /dev/null +++ b/api/UnitXP.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return number currXP +---Returns the player's current amount of experience points +function UnitXP(unit) end \ No newline at end of file diff --git a/api/UnitXPMax.lua b/api/UnitXPMax.lua new file mode 100644 index 0000000..f3ea200 --- /dev/null +++ b/api/UnitXPMax.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param unit string +---@return number playerMaxXP +---Return the total amount of experience points required for the player to gain a level +function UnitXPMax(unit) end \ No newline at end of file diff --git a/api/UnlearnSpecialization.lua b/api/UnlearnSpecialization.lua new file mode 100644 index 0000000..5b1501a --- /dev/null +++ b/api/UnlearnSpecialization.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnlearnSpecialization() end \ No newline at end of file diff --git a/api/UnlockVoidStorage.lua b/api/UnlockVoidStorage.lua new file mode 100644 index 0000000..fa0ca8e --- /dev/null +++ b/api/UnlockVoidStorage.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UnlockVoidStorage() end \ No newline at end of file diff --git a/api/UpdateAddOnCPUUsage.lua b/api/UpdateAddOnCPUUsage.lua new file mode 100644 index 0000000..ecfd94a --- /dev/null +++ b/api/UpdateAddOnCPUUsage.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Updates addon CPU profiling information. Only has effect if the scriptProfile CVar is set to 1. See GetAddOnCPUUsage() for the updated data. +function UpdateAddOnCPUUsage() end \ No newline at end of file diff --git a/api/UpdateAddOnMemoryUsage.lua b/api/UpdateAddOnMemoryUsage.lua new file mode 100644 index 0000000..90dbe9f --- /dev/null +++ b/api/UpdateAddOnMemoryUsage.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Updates addon memory usage information. See GetAddOnMemoryUsage() for the updated data. +function UpdateAddOnMemoryUsage() end \ No newline at end of file diff --git a/api/UpdateGMTicket.lua b/api/UpdateGMTicket.lua new file mode 100644 index 0000000..4999983 --- /dev/null +++ b/api/UpdateGMTicket.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param text string +---Updates the open GM ticket with new text +function UpdateGMTicket(text) end \ No newline at end of file diff --git a/api/UpdateInventoryAlertStatus.lua b/api/UpdateInventoryAlertStatus.lua new file mode 100644 index 0000000..2904406 --- /dev/null +++ b/api/UpdateInventoryAlertStatus.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UpdateInventoryAlertStatus() end \ No newline at end of file diff --git a/api/UpdateMapHighlight.lua b/api/UpdateMapHighlight.lua new file mode 100644 index 0000000..c3a7c0a --- /dev/null +++ b/api/UpdateMapHighlight.lua @@ -0,0 +1,14 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param cursorX number +---@param cursorY number +---@return string name +---@return string fileName +---@return number texCoordX +---@return number texCoordY +---@return number textureX +---@return number textureY +---@return number scrollChildX +---@return number scrollChildY +---Returns information about the texture used for highlighting zones in a continent map on mouseover +function UpdateMapHighlight(cursorX, cursorY) end \ No newline at end of file diff --git a/api/UpdateWarGamesList.lua b/api/UpdateWarGamesList.lua new file mode 100644 index 0000000..1223ec4 --- /dev/null +++ b/api/UpdateWarGamesList.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UpdateWarGamesList() end \ No newline at end of file diff --git a/api/UpdateWorldMapArrow.lua b/api/UpdateWorldMapArrow.lua new file mode 100644 index 0000000..cf5c7f3 --- /dev/null +++ b/api/UpdateWorldMapArrow.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UpdateWorldMapArrow() end \ No newline at end of file diff --git a/api/UpgradeItem.lua b/api/UpgradeItem.lua new file mode 100644 index 0000000..ddfbb3b --- /dev/null +++ b/api/UpgradeItem.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Accepts an item upgrade, spending the required amount of currency. This function can only be called when at the upgrade merchant. +function UpgradeItem() end \ No newline at end of file diff --git a/api/UseAction.lua b/api/UseAction.lua new file mode 100644 index 0000000..6c04b04 --- /dev/null +++ b/api/UseAction.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---@param target string +---@param button RightButton +---@param Button4 +---@param Button5 +---@param LeftButton +---@param MiddleButton +---@param RightButton +---Uses an action +function UseAction(slot, target, button, Button4, Button5, LeftButton, MiddleButton, RightButton) end \ No newline at end of file diff --git a/api/UseContainerItem.lua b/api/UseContainerItem.lua new file mode 100644 index 0000000..26ea891 --- /dev/null +++ b/api/UseContainerItem.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param container number +---@param slot number +---@param target string +---@param reagentBankAccessible boolean +---Activate (as with right-clicking) an item in one of the player's bags. Has the same effect as right-clicking an item in the default UI; therefore, results may vary by context. In cases of conflict, conditions listed first override those below: If the bank, guild bank or reagent bank UI is open, moves the item into the bank, guild bank or reagent bank (or if the item is in the bank, guild bank or reagent bank, moves it into the player's inventory). If the trade UI is open, puts the item into the first available trade slot (or if the item is soulbound, into the "will not be traded" slot). If the merchant UI is open and not in repair mode, attempts to sell the item to the merchant. If the Send Mail UI is open, puts the item into the first available slot for message attachments. If an item is readable (e.g. Lament of the Highborne), opens it for reading. If an item is lootable (e.g. Magically Wrapped Gift), opens it for looting If an item can be equipped, attempts to equip the item (placing any currently equipped item of the same type into the container slot used). If an item has a "Use:" effect, activates said effect. Under this condition only, the function is protected and can only be called by the Blizzard UI. If none of the above conditions are true, nothing happens. +function UseContainerItem(container, slot, target, reagentBankAccessible) end \ No newline at end of file diff --git a/api/UseEquipmentSet.lua b/api/UseEquipmentSet.lua new file mode 100644 index 0000000..f1e0467 --- /dev/null +++ b/api/UseEquipmentSet.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@return boolean equipped +---Equips the items in an equipment set +function UseEquipmentSet(name) end \ No newline at end of file diff --git a/api/UseHearthstone.lua b/api/UseHearthstone.lua new file mode 100644 index 0000000..723f386 --- /dev/null +++ b/api/UseHearthstone.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return boolean state +---Attempts to use the player's Hearthstone. Used by the support/help interface to resolve issues where a player is stuck. +function UseHearthstone() end \ No newline at end of file diff --git a/api/UseInventoryItem.lua b/api/UseInventoryItem.lua new file mode 100644 index 0000000..7456f31 --- /dev/null +++ b/api/UseInventoryItem.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param slot number +---Activate (as with right-clicking) an equipped item. If the inventoryID passed refers to an empty slot or a slot containing an item without a "Use:" action, this function is not protected (i.e. usable only by the Blizzard UI), but also has no effect. +function UseInventoryItem(slot) end \ No newline at end of file diff --git a/api/UseItemByName.lua b/api/UseItemByName.lua new file mode 100644 index 0000000..20c5f9d --- /dev/null +++ b/api/UseItemByName.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemID number +---@param itemName string +---@param itemLink string +---@param target string +---Uses an arbitrary item (optionally on a specified unit) +function UseItemByName(itemID, itemName, itemLink, target) end \ No newline at end of file diff --git a/api/UseItemForTransmogrify.lua b/api/UseItemForTransmogrify.lua new file mode 100644 index 0000000..ca75c0e --- /dev/null +++ b/api/UseItemForTransmogrify.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UseItemForTransmogrify() end \ No newline at end of file diff --git a/api/UseQuestLogSpecialItem.lua b/api/UseQuestLogSpecialItem.lua new file mode 100644 index 0000000..0469360 --- /dev/null +++ b/api/UseQuestLogSpecialItem.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param questIndex number +---Uses the item associated with a current quest. Available for a number of quests which involve using an item (i.e. "Use the MacGuffin to summon and defeat the boss", "Use this saw to fell 12 trees", etc.) +function UseQuestLogSpecialItem(questIndex) end \ No newline at end of file diff --git a/api/UseSoulstone.lua b/api/UseSoulstone.lua new file mode 100644 index 0000000..a2cef80 --- /dev/null +++ b/api/UseSoulstone.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Instantly resurrects the player in place, if possible. Usable if the player is dead (and has not yet released his or her spirit to the graveyard) and has the ability to instantly resurrect (provided by a Warlock's Soulstone or a Shaman's Reincarnation passive ability). +function UseSoulstone() end \ No newline at end of file diff --git a/api/UseToy.lua b/api/UseToy.lua new file mode 100644 index 0000000..2634a58 --- /dev/null +++ b/api/UseToy.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param itemID number +---Use a Toy. This API is protected. If you wish to provide interface for users to access a toy, create a SecureActionButton and set the type attribute to "item" and the item attribute to the itemString stub (such as "item:####") +function UseToy(itemID) end \ No newline at end of file diff --git a/api/UseToyByName.lua b/api/UseToyByName.lua new file mode 100644 index 0000000..d16fb45 --- /dev/null +++ b/api/UseToyByName.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---Activates a toy from the Toy Box +function UseToyByName(name) end \ No newline at end of file diff --git a/api/UseVoidItemForTransmogrify.lua b/api/UseVoidItemForTransmogrify.lua new file mode 100644 index 0000000..21b8dc8 --- /dev/null +++ b/api/UseVoidItemForTransmogrify.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function UseVoidItemForTransmogrify() end \ No newline at end of file diff --git a/api/ValidateTransmogrifications.lua b/api/ValidateTransmogrifications.lua new file mode 100644 index 0000000..1dde6a2 --- /dev/null +++ b/api/ValidateTransmogrifications.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function ValidateTransmogrifications() end \ No newline at end of file diff --git a/api/VehicleAimDecrement.lua b/api/VehicleAimDecrement.lua new file mode 100644 index 0000000..0819142 --- /dev/null +++ b/api/VehicleAimDecrement.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param amount number +---Adjusts vehicle aim downward by a specified amount +function VehicleAimDecrement(amount) end \ No newline at end of file diff --git a/api/VehicleAimDownStart.lua b/api/VehicleAimDownStart.lua new file mode 100644 index 0000000..ab6fa82 --- /dev/null +++ b/api/VehicleAimDownStart.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Starts adjusting vehicle aim downward +function VehicleAimDownStart() end \ No newline at end of file diff --git a/api/VehicleAimDownStop.lua b/api/VehicleAimDownStop.lua new file mode 100644 index 0000000..2dee28f --- /dev/null +++ b/api/VehicleAimDownStop.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Stops adjusting vehicle aim downward +function VehicleAimDownStop() end \ No newline at end of file diff --git a/api/VehicleAimGetAngle.lua b/api/VehicleAimGetAngle.lua new file mode 100644 index 0000000..b40f760 --- /dev/null +++ b/api/VehicleAimGetAngle.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number angle +---Returns the aim angle of a vehicle weapon. The returned value is in radians, with positive values indicating upward angle, negative values indicating downward angle, and 0 indicating straight ahead. +function VehicleAimGetAngle() end \ No newline at end of file diff --git a/api/VehicleAimGetNormAngle.lua b/api/VehicleAimGetNormAngle.lua new file mode 100644 index 0000000..fb11b34 --- /dev/null +++ b/api/VehicleAimGetNormAngle.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number angle +---Returns the aim angle of a vehicle weapon relative to its minimum angle. The returned value is in radians, with 0 indicating the lowest angle allowed for the vehicle weapon and increasing values for upward aim. +function VehicleAimGetNormAngle() end \ No newline at end of file diff --git a/api/VehicleAimGetNormPower.lua b/api/VehicleAimGetNormPower.lua new file mode 100644 index 0000000..e3a6721 --- /dev/null +++ b/api/VehicleAimGetNormPower.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function VehicleAimGetNormPower() end \ No newline at end of file diff --git a/api/VehicleAimIncrement.lua b/api/VehicleAimIncrement.lua new file mode 100644 index 0000000..c306b80 --- /dev/null +++ b/api/VehicleAimIncrement.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param amount number +---Adjusts vehicle aim upward by a specified amount +function VehicleAimIncrement(amount) end \ No newline at end of file diff --git a/api/VehicleAimRequestAngle.lua b/api/VehicleAimRequestAngle.lua new file mode 100644 index 0000000..88aa3e2 --- /dev/null +++ b/api/VehicleAimRequestAngle.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param amount number +---Attempts to set a vehicle weapon's aim angle to a specific value. Causes aim angle to transition smoothly from the current value to the requested value (or to the closest allowed value to the requested value if it is beyond the vehicle's limits). Aim angle values are in radians, with positive values indicating upward angle, negative values indicating downward angle, and 0 indicating straight ahead. +function VehicleAimRequestAngle(amount) end \ No newline at end of file diff --git a/api/VehicleAimRequestNormAngle.lua b/api/VehicleAimRequestNormAngle.lua new file mode 100644 index 0000000..21ffc16 --- /dev/null +++ b/api/VehicleAimRequestNormAngle.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param amount number +---Attempts to set a vehicle weapon's aim angle to a specific value relative to its minimum value. Causes aim angle to transition smoothly from the current value to the requested value (or to the closest allowed value to the requested value if it is beyond the vehicle's limits). The returned value is in radians, with 0 indicating the lowest angle allowed for the vehicle weapon and increasing values for upward aim. +function VehicleAimRequestNormAngle(amount) end \ No newline at end of file diff --git a/api/VehicleAimSetNormPower.lua b/api/VehicleAimSetNormPower.lua new file mode 100644 index 0000000..82ef03b --- /dev/null +++ b/api/VehicleAimSetNormPower.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function VehicleAimSetNormPower() end \ No newline at end of file diff --git a/api/VehicleAimUpStart.lua b/api/VehicleAimUpStart.lua new file mode 100644 index 0000000..71ca082 --- /dev/null +++ b/api/VehicleAimUpStart.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Starts adjusting vehicle aim upward +function VehicleAimUpStart() end \ No newline at end of file diff --git a/api/VehicleAimUpStop.lua b/api/VehicleAimUpStop.lua new file mode 100644 index 0000000..b5c6efa --- /dev/null +++ b/api/VehicleAimUpStop.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Stops adjusting vehicle aim upward +function VehicleAimUpStop() end \ No newline at end of file diff --git a/api/VehicleCameraZoomIn.lua b/api/VehicleCameraZoomIn.lua new file mode 100644 index 0000000..b65b364 --- /dev/null +++ b/api/VehicleCameraZoomIn.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Zooms the player's view in while in a vehicle +function VehicleCameraZoomIn() end \ No newline at end of file diff --git a/api/VehicleCameraZoomOut.lua b/api/VehicleCameraZoomOut.lua new file mode 100644 index 0000000..b325b6b --- /dev/null +++ b/api/VehicleCameraZoomOut.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Zooms the player's view out while in a vehicle +function VehicleCameraZoomOut() end \ No newline at end of file diff --git a/api/VehicleExit.lua b/api/VehicleExit.lua new file mode 100644 index 0000000..da7dff9 --- /dev/null +++ b/api/VehicleExit.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Removes the player from the current vehicle. Does nothing if the player is not in a vehicle. +function VehicleExit() end \ No newline at end of file diff --git a/api/VehicleNextSeat.lua b/api/VehicleNextSeat.lua new file mode 100644 index 0000000..0273acb --- /dev/null +++ b/api/VehicleNextSeat.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Moves the player from his current seat in a vehicle to the next sequentially numbered seat. If the player is in the highest-numbered seat, cycles around to the lowest-numbered seat. +function VehicleNextSeat() end \ No newline at end of file diff --git a/api/VehiclePrevSeat.lua b/api/VehiclePrevSeat.lua new file mode 100644 index 0000000..3c07891 --- /dev/null +++ b/api/VehiclePrevSeat.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Moves the player from his current seat in a vehicle to the previous sequentially numbered seat. If the player is in the lowest-numbered seat, cycles around to the highest-numbered seat. +function VehiclePrevSeat() end \ No newline at end of file diff --git a/api/ViewGuildRecipes.lua b/api/ViewGuildRecipes.lua new file mode 100644 index 0000000..9ad84fe --- /dev/null +++ b/api/ViewGuildRecipes.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param professionID number +---Opens the guild profession view for a profession. Opens the guild profession view for the specified profession. +function ViewGuildRecipes(professionID) end \ No newline at end of file diff --git a/api/VoiceChat_ActivatePrimaryCaptureCallback.lua b/api/VoiceChat_ActivatePrimaryCaptureCallback.lua new file mode 100644 index 0000000..a223bef --- /dev/null +++ b/api/VoiceChat_ActivatePrimaryCaptureCallback.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function VoiceChat_ActivatePrimaryCaptureCallback() end \ No newline at end of file diff --git a/api/VoiceChat_GetCurrentMicrophoneSignalLevel.lua b/api/VoiceChat_GetCurrentMicrophoneSignalLevel.lua new file mode 100644 index 0000000..b0511d9 --- /dev/null +++ b/api/VoiceChat_GetCurrentMicrophoneSignalLevel.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number volume +---Returns the current volume level of the microphone signal +function VoiceChat_GetCurrentMicrophoneSignalLevel() end \ No newline at end of file diff --git a/api/VoiceChat_IsPlayingLoopbackSound.lua b/api/VoiceChat_IsPlayingLoopbackSound.lua new file mode 100644 index 0000000..58c3d75 --- /dev/null +++ b/api/VoiceChat_IsPlayingLoopbackSound.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param isPlaying number +---Returns whether the Microphone Test recording is playing +function VoiceChat_IsPlayingLoopbackSound(isPlaying) end \ No newline at end of file diff --git a/api/VoiceChat_IsRecordingLoopbackSound.lua b/api/VoiceChat_IsRecordingLoopbackSound.lua new file mode 100644 index 0000000..dfdd242 --- /dev/null +++ b/api/VoiceChat_IsRecordingLoopbackSound.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number isRecording +---Returns whether a Microphone Test is recording +function VoiceChat_IsRecordingLoopbackSound() end \ No newline at end of file diff --git a/api/VoiceChat_PlayLoopbackSound.lua b/api/VoiceChat_PlayLoopbackSound.lua new file mode 100644 index 0000000..c251982 --- /dev/null +++ b/api/VoiceChat_PlayLoopbackSound.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Plays back the Microphone Test recording +function VoiceChat_PlayLoopbackSound() end \ No newline at end of file diff --git a/api/VoiceChat_RecordLoopbackSound.lua b/api/VoiceChat_RecordLoopbackSound.lua new file mode 100644 index 0000000..3cd0a6c --- /dev/null +++ b/api/VoiceChat_RecordLoopbackSound.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param seconds number +---Begins recording a Microphone Test +function VoiceChat_RecordLoopbackSound(seconds) end \ No newline at end of file diff --git a/api/VoiceChat_StartCapture.lua b/api/VoiceChat_StartCapture.lua new file mode 100644 index 0000000..2dcfd27 --- /dev/null +++ b/api/VoiceChat_StartCapture.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function VoiceChat_StartCapture() end \ No newline at end of file diff --git a/api/VoiceChat_StopCapture.lua b/api/VoiceChat_StopCapture.lua new file mode 100644 index 0000000..d8a5f08 --- /dev/null +++ b/api/VoiceChat_StopCapture.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function VoiceChat_StopCapture() end \ No newline at end of file diff --git a/api/VoiceChat_StopPlayingLoopbackSound.lua b/api/VoiceChat_StopPlayingLoopbackSound.lua new file mode 100644 index 0000000..32fc328 --- /dev/null +++ b/api/VoiceChat_StopPlayingLoopbackSound.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Stops playing the Microphone Test recording +function VoiceChat_StopPlayingLoopbackSound() end \ No newline at end of file diff --git a/api/VoiceChat_StopRecordingLoopbackSound.lua b/api/VoiceChat_StopRecordingLoopbackSound.lua new file mode 100644 index 0000000..1a53e9d --- /dev/null +++ b/api/VoiceChat_StopRecordingLoopbackSound.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Stops recording a Microphone Test +function VoiceChat_StopRecordingLoopbackSound() end \ No newline at end of file diff --git a/api/VoiceEnumerateCaptureDevices.lua b/api/VoiceEnumerateCaptureDevices.lua new file mode 100644 index 0000000..0646da1 --- /dev/null +++ b/api/VoiceEnumerateCaptureDevices.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param deviceIndex number +---@return string deviceName +---Returns the name of an audio input device for voice chat +function VoiceEnumerateCaptureDevices(deviceIndex) end \ No newline at end of file diff --git a/api/VoiceEnumerateOutputDevices.lua b/api/VoiceEnumerateOutputDevices.lua new file mode 100644 index 0000000..dfe4d9f --- /dev/null +++ b/api/VoiceEnumerateOutputDevices.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param deviceIndex number +---@return string device +---Returns the name of an audio output device for voice chat +function VoiceEnumerateOutputDevices(deviceIndex) end \ No newline at end of file diff --git a/api/VoiceGetCurrentCaptureDevice.lua b/api/VoiceGetCurrentCaptureDevice.lua new file mode 100644 index 0000000..a2f2333 --- /dev/null +++ b/api/VoiceGetCurrentCaptureDevice.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number index +---Returns the index of the current voice capture device +function VoiceGetCurrentCaptureDevice() end \ No newline at end of file diff --git a/api/VoiceGetCurrentOutputDevice.lua b/api/VoiceGetCurrentOutputDevice.lua new file mode 100644 index 0000000..0f3fbba --- /dev/null +++ b/api/VoiceGetCurrentOutputDevice.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number index +---Returns the index of the current voice output device +function VoiceGetCurrentOutputDevice() end \ No newline at end of file diff --git a/api/VoiceIsDisabledByClient.lua b/api/VoiceIsDisabledByClient.lua new file mode 100644 index 0000000..ce42f7a --- /dev/null +++ b/api/VoiceIsDisabledByClient.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil isDisabled +---Returns whether the voice chat system cannot be enabled. Voice chat may be disabled if the underlying hardware does not support it or if multiple instances of World of Warcraft are running on the same hardware. +function VoiceIsDisabledByClient() end \ No newline at end of file diff --git a/api/VoicePushToTalkStart.lua b/api/VoicePushToTalkStart.lua new file mode 100644 index 0000000..cb7592a --- /dev/null +++ b/api/VoicePushToTalkStart.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Used internally to start talking, when push-to-talk is active in voice chat. +function VoicePushToTalkStart() end \ No newline at end of file diff --git a/api/VoicePushToTalkStop.lua b/api/VoicePushToTalkStop.lua new file mode 100644 index 0000000..4a1ffce --- /dev/null +++ b/api/VoicePushToTalkStop.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Used internally to stop talking, when push-to-talk is active in voice chat +function VoicePushToTalkStop() end \ No newline at end of file diff --git a/api/VoiceSelectCaptureDevice.lua b/api/VoiceSelectCaptureDevice.lua new file mode 100644 index 0000000..c66af04 --- /dev/null +++ b/api/VoiceSelectCaptureDevice.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param deviceName string +---Selects an audio input device for voice chat +function VoiceSelectCaptureDevice(deviceName) end \ No newline at end of file diff --git a/api/VoiceSelectOutputDevice.lua b/api/VoiceSelectOutputDevice.lua new file mode 100644 index 0000000..ae1847f --- /dev/null +++ b/api/VoiceSelectOutputDevice.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param deviceName string +---Selects an audio output device for voice chat +function VoiceSelectOutputDevice(deviceName) end \ No newline at end of file diff --git a/api/WarGameRespond.lua b/api/WarGameRespond.lua new file mode 100644 index 0000000..27e31f0 --- /dev/null +++ b/api/WarGameRespond.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function WarGameRespond() end \ No newline at end of file diff --git a/api/WithdrawGuildBankMoney.lua b/api/WithdrawGuildBankMoney.lua new file mode 100644 index 0000000..c0d8723 --- /dev/null +++ b/api/WithdrawGuildBankMoney.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param amount number +---Attempts to withdraw money from the guild bank. Causes a PLAYER_MONEY event to fire, indicating the amount withdrawn has been added to the player's total (see GetMoney()). Causes an error or system message if amount exceeds the amount of money in the guild bank or the player's allowed daily withdrawal amount. +function WithdrawGuildBankMoney(amount) end \ No newline at end of file diff --git a/api/ZoomOut.lua b/api/ZoomOut.lua new file mode 100644 index 0000000..037c908 --- /dev/null +++ b/api/ZoomOut.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Sets the world map to show the area containing its current area. Only used by the default UI in certain circumstances: to "zoom out" from a multi-level map (e.g. Dalaran or a dungeon) to the containing zone/continent. May cause problems when not used in such cases. +function ZoomOut() end \ No newline at end of file diff --git a/api/acos.lua b/api/acos.lua new file mode 100644 index 0000000..31c040e --- /dev/null +++ b/api/acos.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Alternative to math.acos, using degrees instead of radians +function acos() end \ No newline at end of file diff --git a/api/asin.lua b/api/asin.lua new file mode 100644 index 0000000..8e1d0aa --- /dev/null +++ b/api/asin.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Alternative to math.asin, using degrees instead of radians +function asin() end \ No newline at end of file diff --git a/api/assert.lua b/api/assert.lua new file mode 100644 index 0000000..ed04b43 --- /dev/null +++ b/api/assert.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param condition value +---@param message string +---@return value value +---Causes a Lua error if a condition is failed +function assert(condition, message) end \ No newline at end of file diff --git a/api/atan.lua b/api/atan.lua new file mode 100644 index 0000000..1700fad --- /dev/null +++ b/api/atan.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Alternative to math.atan, using degrees instead of radians +function atan() end \ No newline at end of file diff --git a/api/atan2.lua b/api/atan2.lua new file mode 100644 index 0000000..1741d4e --- /dev/null +++ b/api/atan2.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function atan2() end \ No newline at end of file diff --git a/api/ceil.lua b/api/ceil.lua new file mode 100644 index 0000000..c186268 --- /dev/null +++ b/api/ceil.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param x number +---@return number ceiling +---Returns the smallest integer larger than or equal to a number. Alias for the standard library function math.ceil. +function ceil(x) end \ No newline at end of file diff --git a/api/collectgarbage.lua b/api/collectgarbage.lua new file mode 100644 index 0000000..203c2a3 --- /dev/null +++ b/api/collectgarbage.lua @@ -0,0 +1,13 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param option stop +---@param collect +---@param count +---@param restart +---@param setpause arg +---@param setstepmul arg +---@param step arg +---@param stop +---@param arg +---Interface to the Lua garbage collector +function collectgarbage(option, collect, count, restart, setpause, setstepmul, step, stop, arg) end \ No newline at end of file diff --git a/api/cos.lua b/api/cos.lua new file mode 100644 index 0000000..4fb1eda --- /dev/null +++ b/api/cos.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Alternative to math.cos, using degrees instead of radians +function cos() end \ No newline at end of file diff --git a/api/date.lua b/api/date.lua new file mode 100644 index 0000000..b55dc8c --- /dev/null +++ b/api/date.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param format string +---@param time number +---@return string or table dateValue +---Returns a formatted date/time string for a date (or the current date). Alias to the standard library function os.date. +function date(format, time) end \ No newline at end of file diff --git a/api/debugbreak.lua b/api/debugbreak.lua new file mode 100644 index 0000000..66ce988 --- /dev/null +++ b/api/debugbreak.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function debugbreak() end \ No newline at end of file diff --git a/api/debugdump.lua b/api/debugdump.lua new file mode 100644 index 0000000..da818cf --- /dev/null +++ b/api/debugdump.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function debugdump() end \ No newline at end of file diff --git a/api/debuginfo.lua b/api/debuginfo.lua new file mode 100644 index 0000000..0e92301 --- /dev/null +++ b/api/debuginfo.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function debuginfo() end \ No newline at end of file diff --git a/api/debugload.lua b/api/debugload.lua new file mode 100644 index 0000000..8d4e5c1 --- /dev/null +++ b/api/debugload.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function debugload() end \ No newline at end of file diff --git a/api/debuglocals.lua b/api/debuglocals.lua new file mode 100644 index 0000000..80abe11 --- /dev/null +++ b/api/debuglocals.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param stackLevel number +---@return string localsInfo +---Returns information about the local variables at a given stack depth +function debuglocals(stackLevel) end \ No newline at end of file diff --git a/api/debugprint.lua b/api/debugprint.lua new file mode 100644 index 0000000..54e814f --- /dev/null +++ b/api/debugprint.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function debugprint() end \ No newline at end of file diff --git a/api/debugprofilestart.lua b/api/debugprofilestart.lua new file mode 100644 index 0000000..be3d35a --- /dev/null +++ b/api/debugprofilestart.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Starts/resets the high resolution profiling timer. Subsequent calls to debugprofilestop() will return the current value of the timer. Note that debugprofilestart() is more of a global reset than a "start". It is not necessary to call it, ever. In fact, it is probably a much better idea to simply do 2 calls to stop() and calculate the difference, since calling start() will interrupt timing measurements done by other addons. +function debugprofilestart() end \ No newline at end of file diff --git a/api/debugprofilestop.lua b/api/debugprofilestop.lua new file mode 100644 index 0000000..e1c09ad --- /dev/null +++ b/api/debugprofilestop.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number time +---Returns the value of the profiling timer +function debugprofilestop() end \ No newline at end of file diff --git a/api/debugstack.lua b/api/debugstack.lua new file mode 100644 index 0000000..1878954 --- /dev/null +++ b/api/debugstack.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param start number +---@param countTop number +---@param countBot number +---@return string debugstring +---Returns information about the current function call stack +function debugstack(start, countTop, countBot) end \ No newline at end of file diff --git a/api/debugtimestamp.lua b/api/debugtimestamp.lua new file mode 100644 index 0000000..9f01736 --- /dev/null +++ b/api/debugtimestamp.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function debugtimestamp() end \ No newline at end of file diff --git a/api/difftime.lua b/api/difftime.lua new file mode 100644 index 0000000..2150633 --- /dev/null +++ b/api/difftime.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param time2 number +---@param time1 number +---@return number seconds +---Returns the number of seconds between two time values. Alias for the standard library function os.difftime. +function difftime(time2, time1) end \ No newline at end of file diff --git a/api/error.lua b/api/error.lua new file mode 100644 index 0000000..2377a67 --- /dev/null +++ b/api/error.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param message string +---@param level number +---Causes a Lua error message +function error(message, level) end \ No newline at end of file diff --git a/api/fastrandom.lua b/api/fastrandom.lua new file mode 100644 index 0000000..901f603 --- /dev/null +++ b/api/fastrandom.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function fastrandom() end \ No newline at end of file diff --git a/api/floor.lua b/api/floor.lua new file mode 100644 index 0000000..05b53ef --- /dev/null +++ b/api/floor.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param x number +---@return number floor +---Returns the largest integer smaller than or equal to a number. Alias for the standard library function math.floor. +function floor(x) end \ No newline at end of file diff --git a/api/forceinsecure.lua b/api/forceinsecure.lua new file mode 100644 index 0000000..4f7d100 --- /dev/null +++ b/api/forceinsecure.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Causes the current execution path to continue outside the secure environment. Meaningless when called from outside of the secure environment. +function forceinsecure() end \ No newline at end of file diff --git a/api/foreach.lua b/api/foreach.lua new file mode 100644 index 0000000..7a460b8 --- /dev/null +++ b/api/foreach.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function foreach() end \ No newline at end of file diff --git a/api/foreachi.lua b/api/foreachi.lua new file mode 100644 index 0000000..0f1e9e8 --- /dev/null +++ b/api/foreachi.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function foreachi() end \ No newline at end of file diff --git a/api/format.lua b/api/format.lua new file mode 100644 index 0000000..d6e690b --- /dev/null +++ b/api/format.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param formatString string +---@param ... list +---@return number formatted +---Returns a formatted string containing specified values. Alias for the standard library function string.format. This version, however, includes the positional argument specifiers from Lua 4.0. Lua does not support the ANSI C format specifiers *, l, L, n, p, and h but includes an extra specifier, q, which formats a string in a form suitable to be safely read back by the Lua interpreter: the string is written between double quotes, and all double quotes, newlines, embedded zeros, and backslashes in the string are correctly escaped when written. +function format(formatString, ...) end \ No newline at end of file diff --git a/api/frexp.lua b/api/frexp.lua new file mode 100644 index 0000000..736e659 --- /dev/null +++ b/api/frexp.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param x number +---@return number m +---@return number e +---Returns the normalized fraction and base-2 exponent for a number. Alias for the standard library function math.frexp. +function frexp(x) end \ No newline at end of file diff --git a/api/gcinfo.lua b/api/gcinfo.lua new file mode 100644 index 0000000..dcd1afc --- /dev/null +++ b/api/gcinfo.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return number count +---Returns the total Lua memory usage. Deprecated in Lua 5.1; use collectgarbage("count") instead. +function gcinfo() end \ No newline at end of file diff --git a/api/geterrorhandler.lua b/api/geterrorhandler.lua new file mode 100644 index 0000000..85dcfaa --- /dev/null +++ b/api/geterrorhandler.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return function handler +---Returns the current error handler function +function geterrorhandler() end \ No newline at end of file diff --git a/api/getfenv.lua b/api/getfenv.lua new file mode 100644 index 0000000..e79ace5 --- /dev/null +++ b/api/getfenv.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param f function +---@param stackLevel number +---@return table env +---Returns the environment for a function (or the global environment). If the environment has a __environment metatable, that value is returned instead. +function getfenv(f, stackLevel) end \ No newline at end of file diff --git a/api/getglobal.lua b/api/getglobal.lua new file mode 100644 index 0000000..5fe9f44 --- /dev/null +++ b/api/getglobal.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@return value value +---Returns the value of a global variable. Often used in the default UI in cases where several similar names are systematically constructed. Examples: In a script attached to a frame template, getglobal(self:GetName().."Icon") can refer to the Texture whose name is defined in XML as $parentIcon. Several sets of localized string tokens follow standard formats: e.g. getglobal("ITEM_QUALITY"..quality.."_DESC) returns the name for the numeric quality. Equivalent to _G.name or _G["name"]. +function getglobal(name) end \ No newline at end of file diff --git a/api/getmetatable.lua b/api/getmetatable.lua new file mode 100644 index 0000000..4e5e03d --- /dev/null +++ b/api/getmetatable.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param object value +---@return value metatable +---Returns an object's metatable +function getmetatable(object) end \ No newline at end of file diff --git a/api/getn.lua b/api/getn.lua new file mode 100644 index 0000000..f9074c7 --- /dev/null +++ b/api/getn.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function getn() end \ No newline at end of file diff --git a/api/getprinthandler.lua b/api/getprinthandler.lua new file mode 100644 index 0000000..31e8bd3 --- /dev/null +++ b/api/getprinthandler.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return function printHandler +---Returns the function currently used for print() output.   The print handler is called by the print(...) function, with all arguments passed along. +function getprinthandler() end \ No newline at end of file diff --git a/api/gmatch.lua b/api/gmatch.lua new file mode 100644 index 0000000..69beef1 --- /dev/null +++ b/api/gmatch.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param s string +---@param pattern string +---@return function iterator +---Returns an iterator function for finding pattern matches in a string. Alias for the standard library function string.gmatch. +function gmatch(s, pattern) end \ No newline at end of file diff --git a/api/gsub.lua b/api/gsub.lua new file mode 100644 index 0000000..914c2eb --- /dev/null +++ b/api/gsub.lua @@ -0,0 +1,12 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param s string +---@param pattern string +---@param rep string +---@param repTable table +---@param repFunc function +---@param maxReplaced number +---@return string newString +---@return number numMatched +---Returns a string in which occurrences of a pattern are replaced. Alias for the standard library function string.gsub. +function gsub(s, pattern, rep, repTable, repFunc, maxReplaced) end \ No newline at end of file diff --git a/api/hooksecurefunc.lua b/api/hooksecurefunc.lua new file mode 100644 index 0000000..25de471 --- /dev/null +++ b/api/hooksecurefunc.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param table table +---@param function string +---@param hookfunc function +---Add a function to be called after execution of a secure function. Allows one to "post-hook" a secure function without tainting the original. The original function will still be called, but the function supplied will be called after the original, with the same arguments. Return values from the supplied function are discarded. Note that there is no API to remove a hook from a function: any hooks applied will remain in place until the UI is reloaded. Only allows hooking of functions named by a global variable; to hook a script handler on a Frame object, see Frame:HookScript(). +function hooksecurefunc(table, function, hookfunc) end \ No newline at end of file diff --git a/api/ipairs.lua b/api/ipairs.lua new file mode 100644 index 0000000..4606c69 --- /dev/null +++ b/api/ipairs.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param t table +---@return function iterator +---@return table t +---@return number index +---Returns an iterator function for integer keys in a table. Return values are such that the construction for k,v in ipairs(t) do -- body end will iterate over the pairs 1,t[1], 2,t[2], etc, up to the first integer key absent from the table. +function ipairs(t) end \ No newline at end of file diff --git a/api/issecure.lua b/api/issecure.lua new file mode 100644 index 0000000..6a6269d --- /dev/null +++ b/api/issecure.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@return 1nil secure +---Returns whether the current execution path is secure. Meaningless when called from outside of the secure environment: always returns nil in such situations. +function issecure() end \ No newline at end of file diff --git a/api/issecurevariable.lua b/api/issecurevariable.lua new file mode 100644 index 0000000..c64cee9 --- /dev/null +++ b/api/issecurevariable.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param table table +---@param variable string +---@return 1nil issecure +---@return string taint +---Returns whether a variable is secure (and if not, which addon tainted it) +function issecurevariable(table, variable) end \ No newline at end of file diff --git a/api/ldexp.lua b/api/ldexp.lua new file mode 100644 index 0000000..53b7fe8 --- /dev/null +++ b/api/ldexp.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param m number +---@param e number +---@return number x +---Returns the number generated by a normalized fraction and base-2 exponent. Alias for the standard library function math.ldexp. +function ldexp(m, e) end \ No newline at end of file diff --git a/api/loadstring.lua b/api/loadstring.lua new file mode 100644 index 0000000..94478b4 --- /dev/null +++ b/api/loadstring.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param s string +---@param chunkname string +---@return function chunk +---@return string error +---Loads and compiles Lua source code +function loadstring(s, chunkname) end \ No newline at end of file diff --git a/api/message.lua b/api/message.lua new file mode 100644 index 0000000..68afe50 --- /dev/null +++ b/api/message.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param text string +---Shows a message box containing the given text +function message(text) end \ No newline at end of file diff --git a/api/newproxy.lua b/api/newproxy.lua new file mode 100644 index 0000000..f6bb64b --- /dev/null +++ b/api/newproxy.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param boolean boolean +---@param userdata userdata +---@return userdata userdata +---Creates a zero-length userdata with an optional metatable.. newproxy is a experimental, undocumented and unsupported function in the Lua base library. It can be used to create a zero-length userdata, with a optional proxy. This function allows you to bypass the table type restriction on setmetatable, and thus create just a metatable. One of the main benefits from doing this is that you don't have to take the full overhead of creating a dummy table, and it's the only object that honors the metamethod __len. +function newproxy(boolean, userdata) end \ No newline at end of file diff --git a/api/next.lua b/api/next.lua new file mode 100644 index 0000000..e3c9968 --- /dev/null +++ b/api/next.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param t table +---@param key value +---@return value nextKey +---@return value nextValue +---Returns the next key/value pair in a table +function next(t, key) end \ No newline at end of file diff --git a/api/pairs.lua b/api/pairs.lua new file mode 100644 index 0000000..6fe662d --- /dev/null +++ b/api/pairs.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param t table +---@return function iterator +---@return table t +---@return number index +---Returns an iterator function for a table. Return values are such that the construction for k,v in pairs(t) -- body end will iterate over all key/value pairs in the table. +function pairs(t) end \ No newline at end of file diff --git a/api/pcall.lua b/api/pcall.lua new file mode 100644 index 0000000..89baef2 --- /dev/null +++ b/api/pcall.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param f function +---@param ... list +---@return boolean status +---@return list or string ... +---Executes a function in protected mode. When running a function in protected mode, any errors do not propagate beyond the function (i.e. they do not stop all execution and call the default error handler). +function pcall(f, ...) end \ No newline at end of file diff --git a/api/print.lua b/api/print.lua new file mode 100644 index 0000000..a1735ad --- /dev/null +++ b/api/print.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param ... list +---Outputs a list of values (in the main chat window by default). The default print handler prints all values passed to it, separated by spaces, to the default chat frame. Values are passed through tostring(), so only number and string values are output in a literal form: tables, functions and userdata are output as a memory address preceded by their type. This behavior can be customized by using setprinthandler() to designate an alternate function for output. +function print(...) end \ No newline at end of file diff --git a/api/random.lua b/api/random.lua new file mode 100644 index 0000000..5fbfa8f --- /dev/null +++ b/api/random.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param m number +---@param n number +---@return number randomNum +---Generates a pseudo-random number. Alias for the standard library function math.random. +function random(m, n) end \ No newline at end of file diff --git a/api/rawequal.lua b/api/rawequal.lua new file mode 100644 index 0000000..d91390d --- /dev/null +++ b/api/rawequal.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param v1 value +---@param v2 function +---@return boolean isEqual +---Returns whether two values are equal without invoking any metamethods +function rawequal(v1, v2) end \ No newline at end of file diff --git a/api/rawget.lua b/api/rawget.lua new file mode 100644 index 0000000..68bead6 --- /dev/null +++ b/api/rawget.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param t table +---@param key value +---@return value value +---Returns the real value associated with a key in a table without invoking any metamethods +function rawget(t, key) end \ No newline at end of file diff --git a/api/rawset.lua b/api/rawset.lua new file mode 100644 index 0000000..b21c9bd --- /dev/null +++ b/api/rawset.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param t table +---@param key value +---@param value value +---Sets the value associated with a key in a table without invoking any metamethods +function rawset(t, key, value) end \ No newline at end of file diff --git a/api/scrub.lua b/api/scrub.lua new file mode 100644 index 0000000..85c1127 --- /dev/null +++ b/api/scrub.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param ... list +---@return list ... +---Replaces non-simple values in a list with nil. All simple values (strings, numbers, and booleans) are passed from the input list to the output list unchanged. Non-simple values (tables, functions, threads, and userdata) are replaced by nil in the output list. +function scrub(...) end \ No newline at end of file diff --git a/api/securecall.lua b/api/securecall.lua new file mode 100644 index 0000000..d94200c --- /dev/null +++ b/api/securecall.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param function function +---@param ... list +---@return list ... +---Calls a function without tainting the execution path. Meaningless when called from outside of the secure environment. Used in Blizzard code to call functions which may be tainted or operate on potentially tainted variables. For example, consider the function CloseSpecialWindows, which iterates through the table UISpecialFrames and hides any frames named therein. Addon authors may put the names of their frames in that table to make them automatically close when the user presses the ESC key, but this taints UISpecialFrames. Were the default UI to then call CloseSpecialWindows normally, every frame in UISpecialFrames would become tainted, which could later lead to errors when handlers on those frames call protected functions. Instead, the default UI uses securecall(CloseSpecialWindows): within CloseSpecialWindows the execution path may become tainted, but afterward the environment remains secure. +function securecall(function, ...) end \ No newline at end of file diff --git a/api/select.lua b/api/select.lua new file mode 100644 index 0000000..92ad976 --- /dev/null +++ b/api/select.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param index number +---@param # string +---@param ... list +---@return list ... +---Returns one or more values from a list (...), or the number of values in a list +function select(index, #, ...) end \ No newline at end of file diff --git a/api/seterrorhandler.lua b/api/seterrorhandler.lua new file mode 100644 index 0000000..c45e9ba --- /dev/null +++ b/api/seterrorhandler.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param errHandler function +---Changes the error handler to a specified function. The error handler is called by Lua's error() function, which in turn is called whenever a Lua error occurs. WoW's default error handler displays the error message, a stack trace and information about the local variables for the function. This dialog will only be shown if the "Show Lua errors" option is enabled in Interface Options. +function seterrorhandler(errHandler) end \ No newline at end of file diff --git a/api/setfenv.lua b/api/setfenv.lua new file mode 100644 index 0000000..6ff7481 --- /dev/null +++ b/api/setfenv.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param f function +---@param stackLevel number +---@param t table +---@return function f +---Sets the environment to be used by a function. If the environment has a __environment metatable, this function will error. +function setfenv(f, stackLevel, t) end \ No newline at end of file diff --git a/api/setglobal.lua b/api/setglobal.lua new file mode 100644 index 0000000..b400ea8 --- /dev/null +++ b/api/setglobal.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param name string +---@param value value +---Sets a global variable to a specified value. Allows setting the value of a global variable in contexts where its name might be overridden by that of a local variable; i.e. setglobal(name, value) is equivalent to _G.name = value or _G["name"] = value. +function setglobal(name, value) end \ No newline at end of file diff --git a/api/setmetatable.lua b/api/setmetatable.lua new file mode 100644 index 0000000..7f5015c --- /dev/null +++ b/api/setmetatable.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param t table +---@param metatable table +---@return table t +---Sets the metatable for a table +function setmetatable(t, metatable) end \ No newline at end of file diff --git a/api/setprinthandler.lua b/api/setprinthandler.lua new file mode 100644 index 0000000..e47d10a --- /dev/null +++ b/api/setprinthandler.lua @@ -0,0 +1,5 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param printHandler function +---Sets a new function to be used for print() output. The print handler is called by the print(...) function, with all arguments passed along. +function setprinthandler(printHandler) end \ No newline at end of file diff --git a/api/sin.lua b/api/sin.lua new file mode 100644 index 0000000..5b40e0f --- /dev/null +++ b/api/sin.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Alternative to math.sin, using degrees instead of radians +function sin() end \ No newline at end of file diff --git a/api/sort.lua b/api/sort.lua new file mode 100644 index 0000000..673d497 --- /dev/null +++ b/api/sort.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param table number +---@param comparator function +---Sorts a table. Alias for the standard library function table.sort. +function sort(table, comparator) end \ No newline at end of file diff --git a/api/sqrt.lua b/api/sqrt.lua new file mode 100644 index 0000000..e41f27a --- /dev/null +++ b/api/sqrt.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param x number +---@return number root +---Returns the square root of a number. Alias for the standard library function math.sqrt. +function sqrt(x) end \ No newline at end of file diff --git a/api/strconcat.lua b/api/strconcat.lua new file mode 100644 index 0000000..31bd08d --- /dev/null +++ b/api/strconcat.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param ... string +---@return string result +---Joins a list of strings (with no separator). Equivalent to strjoin("", ...). If no strings are provided, returns the empty string (""). +function strconcat(...) end \ No newline at end of file diff --git a/api/strjoin.lua b/api/strjoin.lua new file mode 100644 index 0000000..94aa520 --- /dev/null +++ b/api/strjoin.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param sep string +---@param ... list +---@return string text +---Joins a list of strings together with a given separator. If given a list of strings not already in a table, this function can be used instead of table.concat for better performance. Also available as string.join (though not provided by the Lua standard library). +function strjoin(sep, ...) end \ No newline at end of file diff --git a/api/strsplit.lua b/api/strsplit.lua new file mode 100644 index 0000000..82b8f79 --- /dev/null +++ b/api/strsplit.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param sep string +---@param text string +---@param limit number +---@return string ... +---Splits a string based on another seperator string. Also available as string.split (though not provided by the Lua standard library). +function strsplit(sep, text, limit) end \ No newline at end of file diff --git a/api/strtrim.lua b/api/strtrim.lua new file mode 100644 index 0000000..91f190f --- /dev/null +++ b/api/strtrim.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param str string +---@param trimChars string +---@return string text +---Trims leading and trailing characters (whitespace by default) from a string. Also available as string.trim (though not provided by the Lua standard library). +function strtrim(str, trimChars) end \ No newline at end of file diff --git a/api/tContains.lua b/api/tContains.lua new file mode 100644 index 0000000..b0ccd98 --- /dev/null +++ b/api/tContains.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function tContains() end \ No newline at end of file diff --git a/api/tDelete.lua b/api/tDelete.lua new file mode 100644 index 0000000..34e3fbe --- /dev/null +++ b/api/tDelete.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + + +function tDelete() end \ No newline at end of file diff --git a/api/tan.lua b/api/tan.lua new file mode 100644 index 0000000..e1a85e2 --- /dev/null +++ b/api/tan.lua @@ -0,0 +1,4 @@ +---@diagnostic disable: missing-return, lowercase-global + +---Alternative to math.tan, using degrees instead of radians +function tan() end \ No newline at end of file diff --git a/api/time.lua b/api/time.lua new file mode 100644 index 0000000..8999ffd --- /dev/null +++ b/api/time.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param timeDesc table +---@return number t +---Returns the numeric time value for a described date/time (or the current time). Alias for the standard library function os.time. According to the Lua manual, the returned value may vary across different systems; however, the Lua libraries included with current WoW clients on both Mac and Windows share the same implementation. For higher-precision time measurements not convertible to a date, see GetTime(). +function time(timeDesc) end \ No newline at end of file diff --git a/api/tonumber.lua b/api/tonumber.lua new file mode 100644 index 0000000..2e234e4 --- /dev/null +++ b/api/tonumber.lua @@ -0,0 +1,7 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param x value +---@param base number +---@return number numValue +---Returns the numeric value of a string +function tonumber(x, base) end \ No newline at end of file diff --git a/api/tostring.lua b/api/tostring.lua new file mode 100644 index 0000000..c8d47f9 --- /dev/null +++ b/api/tostring.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param value value +---@return string stringValue +---Returns a string representation of a value +function tostring(value) end \ No newline at end of file diff --git a/api/tostringall.lua b/api/tostringall.lua new file mode 100644 index 0000000..ce96d96 --- /dev/null +++ b/api/tostringall.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param ... list +---@return list ... +---Alternative to tostring() for bulk conversion of values. Using tostringall() instead of tostring() when converting a large number of values may result in better performance. +function tostringall(...) end \ No newline at end of file diff --git a/api/type.lua b/api/type.lua new file mode 100644 index 0000000..c9ffe24 --- /dev/null +++ b/api/type.lua @@ -0,0 +1,14 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param v value +---@return userdata typeString +---@return false boolean +---@return function +---@return nil nil +---@return number +---@return string +---@return table +---@return thread +---@return userdata +---Returns a string describing the data type of a value +function type(v) end \ No newline at end of file diff --git a/api/unpack.lua b/api/unpack.lua new file mode 100644 index 0000000..c7d426a --- /dev/null +++ b/api/unpack.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param t table +---@param i number +---@param j number +---@return list ... +---Returns the list of elements in a table. Equivalent to return t[i], t[i+1], ... t[j] for an arbitrary number of elements. +function unpack(t, i, j) end \ No newline at end of file diff --git a/api/wipe.lua b/api/wipe.lua new file mode 100644 index 0000000..9200e19 --- /dev/null +++ b/api/wipe.lua @@ -0,0 +1,6 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param aTable table +---@return table emptyTable +---Removes all entries from a table +function wipe(aTable) end \ No newline at end of file diff --git a/api/xpcall.lua b/api/xpcall.lua new file mode 100644 index 0000000..2c51464 --- /dev/null +++ b/api/xpcall.lua @@ -0,0 +1,8 @@ +---@diagnostic disable: missing-return, lowercase-global + +---@param f function +---@param err function +---@return boolean status +---@return list or string ... +---Executes a function in protected mode with a custom error handler +function xpcall(f, err) end \ No newline at end of file